IDataProvider Interface

Data providers can provide additional values that can be logged during measurements.

Namespace: CompreDriveSDK.Plugins
Assembly: CompreDriveSDK (in CompreDriveSDK.dll) Version: 1.17.16

Syntax

public interface IDataProvider : ICommandAcceptor

Public Interface IDataProvider
	Inherits ICommandAcceptor

The IDataProvider type exposes the following members.

Properties

	Name	Description
	IsReady	Gets a value indicating if the plugin is successfully set up and ready to provide values.
	Unit	Gets the unit of the value, for e.g. display and log purposes.
	ValueName	Gets the name of the value, for e.g. display and log purposes.

Methods

	Name	Description
	AcceptApiInstance	Is called during plugin initialization on CompreDriveControl start and allows the plugin to receive an API interface of the CompreDriveControl instance it is loaded into. (Inherited from ICommandAcceptor)
	ExecuteCommand	Execute the given command. (Inherited from ICommandAcceptor)
	GetAvailableCommands	Get the commands available to run. (Inherited from ICommandAcceptor)
	GetValue	Read the current value of the data provider.
	Setup	Is called once during CompreDriveControl startup, or on user command when starting/stopping plugins. Allows for initialization, e.g. setting up a device connection.
	Shutdown	Is called during CompreDriveControl shutdown or on user command when starting/stopping plugins. Allows for correct disconnection of devices.