IAdapter Interface

Represents the abstract interface for any adapter.

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public interface IAdapter : ISupportLifecycle, 
	IDisposable, IProvideStatus

Public Interface IAdapter
	Inherits ISupportLifecycle, IDisposable, IProvideStatus

public interface class IAdapter : ISupportLifecycle, 
	IDisposable, IProvideStatus

type IAdapter = 
    interface
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
    end

GSF.TimeSeries.Adapters.IAdapter = function();
GSF.TimeSeries.Adapters.IAdapter.createInterface('GSF.TimeSeries.Adapters.IAdapter');

The IAdapter type exposes the following members.

Properties

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or connect on demand.
	ConnectionInfo	Gets connection info for adapter, if any.
	ConnectionString	Gets or sets key/value pair connection information specific to IAdapter.
	DataSource	Gets or sets DataSet based data source available to IAdapter.
	Enabled	Gets or sets a boolean value that indicates whether the object is enabled. (Inherited from ISupportLifecycle)
	ID	Gets or sets the numeric ID associated with this IAdapter.
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization.
	Initialized	Gets or sets flag indicating if the adapter has been initialized successfully.
	InputMeasurementKeys	Gets or sets primary keys of input measurements the adapter expects.
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from ISupportLifecycle)
	Name	Gets or sets name of this IAdapter.
	OutputMeasurements	Gets or sets output measurements that the adapter will produce, if any.
	ProcessedMeasurements	Gets the total number of measurements processed thus far by the IAdapter.
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter.
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
	Status	Gets the current status details about object providing status information. (Inherited from IProvideStatus)
	StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
	SupportsTemporalProcessing	Gets the flag indicating if this adapter supports temporal processing.

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
	GetShortStatus	Gets a short one-line adapter status.
	Initialize	Initializes the state of the object. (Inherited from ISupportLifecycle)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter.
	Start	Starts the adapter, if it is not already running.
	Stop	Stops the adapter.

Top

Events

	Name	Description
	ConfigurationChanged	Event is raised when adapter is aware of a configuration change.
	Disposed	Raised after the source object has been properly disposed. (Inherited from ISupportLifecycle)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated.
	OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated.
	ProcessException	Event is raised when there is an exception encountered while processing.
	StatusMessage	Provides status messages to consumer.

Top

Extension Methods

	Name	Description
	GetMeasurementRecord	Gets measurement record, creating it if needed. (Defined by MetadataHelpers)
	GetParentDevice	Gets ID of parent device, creating or updating record if needed, for the current IAdapter instance. (Defined by MetadataHelpers)
	InputMeasurementKeys	Returns the MeasurementKey values of the IAdapter input measurements. (Defined by IAdapterExtensions)
	LookupDevice	Looks up associated device acronym and ID from provided signalID. (Defined by MetadataHelpers)
	LookupMeasurementKey	Looks up or creates measurement key based on provided signalID. (Defined by MetadataHelpers)
	LookupPointTag	Looks up point tag name from provided signalID. (Defined by MetadataHelpers)
	LookupSignalReference	Looks up signal reference from provided signalID. (Defined by MetadataHelpers)
	OnConfigurationChanged	Notifies host system of configuration changes. (Defined by MetadataHelpers)
	OutputMeasurementKeys	Returns the MeasurementKey values of the IAdapter output measurements. (Defined by IAdapterExtensions)
	PointTagExists	Determines if pointTag exists in local configuration. (Defined by MetadataHelpers)
	SignalIDExists	Determines if signalID exists in local configuration. (Defined by MetadataHelpers)
	SignalReferenceExists	Determines if signalReference exists in local configuration. (Defined by MetadataHelpers)
	TemporalConstraintIsDefined	Returns true if IAdapter has a temporal constraint defined, i.e., either StartTimeConstraint or StopTimeConstraint is not set to its default value. (Defined by IAdapterExtensions)
	WaitForSignalsToLoad	Waits for signalIDs to be loaded in system configuration. (Defined by MetadataHelpers)

Top

Reference

GSF.TimeSeries.Adapters Namespace