AdapterBase Class

Represents the base class for any adapter.

Inheritance Hierarchy

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
    GSF.TimeSeries.AdaptersFilterAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
    GSF.TimeSeries.AdaptersOutputAdapterBase

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

Syntax

C++

JavaScript

Copy

public abstract class AdapterBase : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus

Public MustInherit Class AdapterBase
	Implements IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

public ref class AdapterBase abstract : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus

[<AbstractClassAttribute>]
type AdapterBase = 
    class
        interface IAdapter
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
    end

GSF.TimeSeries.Adapters.AdapterBase = function();

Type.createClass(
	'GSF.TimeSeries.Adapters.AdapterBase',
	null,
	GSF.TimeSeries.Adapters.IAdapter,
	GSF.ISupportLifecycle,
	IDisposable,
	GSF.IProvideStatus);

View Source

The AdapterBase type exposes the following members.

Constructors

	Name	Description
	AdapterBase	Constructs a new instance of the AdapterBase.

Top

Properties

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
	ConnectionInfo	Gets connection info for adapter, if any.
	ConnectionString	Gets or sets key/value pair connection information specific to this AdapterBase.
	DataSource	Gets or sets DataSet based data source available to this AdapterBase.
	Enabled	Gets or sets enabled state of this AdapterBase.
	ID	Gets or sets numeric ID associated with this AdapterBase.
	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 AdapterBase expects, if any.
	IsDisposed	Gets a flag that indicates whether the object has been disposed.
	Log	Log messages generated by an adapter.
	MeasurementReportingInterval	Gets or sets the measurement reporting interval.
	Name	Gets or sets the name of this AdapterBase.
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any.
	ProcessedMeasurements	Gets the total number of measurements handled thus far by the AdapterBase.
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter.
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active.
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
	StartTime	Gets the UTC time this AdapterBase was started.
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
	Status	Gets the status of this AdapterBase.
	StopTime	Gets the UTC time this AdapterBase was stopped.
	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	Releases all the resources used by the AdapterBase object.
	Dispose(Boolean)	Releases the unmanaged resources used by the AdapterBase object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Overrides ObjectFinalize)
	GetHashCode	Serves as a hash function for the current AdapterBase. (Overrides ObjectGetHashCode)
	GetShortStatus	Gets a short one-line status of this AdapterBase.
	GetStatusWithMessageLevelPrefix	Gets status message with common time-series messaging prefix for given MessageLevel.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IncrementProcessedMeasurements	Safely increments the total processed measurements.
	Initialize	Initializes AdapterBase.
	LoadInputSourceIDs	Loads an IOutputAdapter or IActionAdapter instance's input measurement keys from a specific set of source ID's.
	LoadOutputSourceIDs	Loads an IInputAdapter or IActionAdapter instance's output measurements from a specific set of source ID's.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event.
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event.
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event.
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event.
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event.
	OnStatusMessage(String)	Obsolete. Raises the StatusMessage event.
	OnStatusMessage(String, Object)	Obsolete. Raises the StatusMessage event with a formatted status message.
	OnStatusMessage(MessageLevel, String, String, MessageFlags)	Raises the StatusMessage event and sends this data to the Logger.
	ParseFilterExpression	Parses a standard FILTER styles expression into its constituent parts.
	ParseInputMeasurementKeys	Parses input measurement keys from connection string setting.
	ParseOutputMeasurementKeys	Parses output measurement keys from connection string setting.
	ParseOutputMeasurements	Parses output measurements from connection string setting.
	ParseTimeTag	Parses a string formatted as an absolute or relative time tag.
	SetInitializedState	Manually sets the initialized state of the AdapterBase.
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter.
	Start	Starts the AdapterBase or restarts it if it is already running.
	Stop	Stops the AdapterBase.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	ConfigurationChanged	Event is raised when adapter is aware of a configuration change.
	Disposed	Event is raised when AdapterBase is disposed.
	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

Fields

	Name	Description
	DefaultInitializationTimeout	Default initialization timeout.
	DefaultMeasurementReportingInterval	Default measurement reporting interval.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	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