InputAdapterBase Class

Represents the base class for any incoming input adapter.

Inheritance Hierarchy

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      GSF.TimeSeries.TransportDataSubscriber

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

Syntax

C++

JavaScript

Copy

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

Public MustInherit Class InputAdapterBase
	Inherits AdapterBase
	Implements IInputAdapter, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus

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

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

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

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

View Source

The InputAdapterBase type exposes the following members.

Constructors

	Name	Description
	InputAdapterBase	Constructs a new instance of the InputAdapterBase.

Top

Properties

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	ConnectionAttemptInterval	Gets or sets the connection attempt interval, in milliseconds, for the data input source.
	ConnectionInfo	Gets connection info for adapter, if any. (Inherited from AdapterBase)
	ConnectionString	Gets or sets key/value pair connection information specific to this AdapterBase. (Inherited from AdapterBase)
	DataSource	Gets or sets DataSet based data source available to this AdapterBase. (Inherited from AdapterBase)
	EnableConnectionErrors	When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization. (Inherited from AdapterBase)
	Initialized	Gets or sets flag indicating if the adapter has been initialized successfully. (Inherited from AdapterBase)
	InputMeasurementKeys	Gets or sets primary keys of input measurements the AdapterBase expects, if any.
	IsConnected	Gets flag that determines if InputAdapterBase is connected.
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterBase)
	Log	Log messages generated by an adapter. (Inherited from AdapterBase)
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from AdapterBase)
	OutputSourceIDs	Gets or sets Source values used to filter output measurements.
	ProcessedMeasurements	Gets the total number of measurements handled thus far by the AdapterBase. (Inherited from AdapterBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter. (Inherited from AdapterBase)
	RequestedOutputMeasurementKeys	Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterBase)
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterBase)
	StartTime	Gets the UTC time this AdapterBase was started. (Inherited from AdapterBase)
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	Status	Returns the detailed status of the data input source. (Overrides AdapterBaseStatus)
	StopTime	Gets the UTC time this AdapterBase was stopped. (Inherited from AdapterBase)
	StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	SupportsTemporalProcessing	Gets the flag indicating if this adapter supports temporal processing. (Inherited from AdapterBase)
	UseAsyncConnect	Gets flag that determines if the data input connects asynchronously.

Top

Methods

	Name	Description
	AttemptConnection	Attempts to connect to data input source.
	AttemptDisconnection	Attempts to disconnect from data input source.
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the InputAdapterBase object and optionally releases the managed resources. (Overrides AdapterBaseDispose(Boolean))
	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. (Inherited from AdapterBase)
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Gets a short one-line status of this AdapterBase. (Inherited from AdapterBase)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IncrementProcessedMeasurements	Safely increments the total processed measurements. (Inherited from AdapterBase)
	Initialize	Initializes InputAdapterBase. (Overrides AdapterBaseInitialize)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnConnected	Called when data input source connection is established.
	OnDisconnected	Called when data input source is disconnected.
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	OnNewMeasurements	Raises the NewMeasurements event.
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event. (Inherited from AdapterBase)
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessingComplete	Raises the ProcessingComplete event.
	OnStatusMessage(String)	Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase)
	OnStatusMessage(String, Object)	Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase)
	OnStatusMessage(MessageLevel, String, String, MessageFlags)	Raises the StatusMessage event and sends this data to the Logger. (Inherited from AdapterBase)
	SetInitializedState	Manually sets the initialized state of the AdapterBase. (Inherited from AdapterBase)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from AdapterBase)
	Start	Starts this InputAdapterBase and initiates connection cycle to data input source. (Overrides AdapterBaseStart)
	Stop	Stops this InputAdapterBase and disconnects from data input source. (Overrides AdapterBaseStop)
	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. (Inherited from AdapterBase)
	Disposed	Event is raised when AdapterBase is disposed. (Inherited from AdapterBase)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated. (Inherited from AdapterBase)
	NewMeasurements	Provides new measurements from input adapter.
	OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated. (Inherited from AdapterBase)
	ProcessException	Event is raised when there is an exception encountered while processing. (Inherited from AdapterBase)
	ProcessingComplete	Indicates to the host that processing for the input adapter has completed.
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)

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)
	InputMeasurementKeys	Returns the MeasurementKey values of the IAdapter input measurements. (Defined by IAdapterExtensions)
	OutputMeasurementKeys	Returns the MeasurementKey values of the IAdapter output measurements. (Defined by IAdapterExtensions)
	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)

Top

Remarks

Derived classes are expected to call OnNewMeasurements(ICollectionIMeasurement) when new measurements are received.

Reference

GSF.TimeSeries.Adapters Namespace