OutputAdapterBase Class

SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersOutputAdapterBase

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

Public MustInherit Class OutputAdapterBase
	Inherits AdapterBase
	Implements IOutputAdapter, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus

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

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

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

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

View Source

	Name	Description
	OutputAdapterBase	Constructs a new instance of the OutputAdapterBase.

Top

	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 output adapter.
	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 OutputAdapterBase. (Overrides AdapterBaseDataSource)
	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. (Inherited from AdapterBase)
	InputSourceIDs	Gets or sets Source values used to filter input measurements.
	InternalProcessQueue	Allows derived class access to internal processing queue.
	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)
	MetadataRefreshOperation	Gets the operation that calls ExecuteMetadataRefresh.
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputIsForArchive	Gets the flag that determines if measurements sent to this OutputAdapterBase are destined for archival.
	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. (Inherited from AdapterBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the output adapter. (Overrides AdapterBaseProcessingInterval)
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
	RequeueOnException	Gets or sets whether or not to automatically place measurements back into the processing queue if an exception occurs while processing. Defaults to false.
	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. Derived classes should extend status with implementation specific information. (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 OutputAdapterBase implementation supports temporal processing. (Overrides AdapterBaseSupportsTemporalProcessing)
	UseAsyncConnect	Gets flag that determines if the data output stream connects asynchronously.

Top

	Name	Description
	AttemptConnection	Attempts to connect to data output stream.
	AttemptDisconnection	Attempts to disconnect from data output stream.
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the OutputAdapterBase 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)
	ExecuteMetadataRefresh	Executes the metadata refresh in a synchronous fashion.
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	Flush	Blocks the current thread, if the OutputAdapterBase is connected, until all items in OutputAdapterBase queue are processed, and then stops processing.
	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 OutputAdapterBase. (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 output source connection is established.
	OnDisconnected	Called when data input source is disconnected.
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	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)
	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)
	OnUnprocessedMeasurements	Raises the UnprocessedMeasurements event.
	ProcessMeasurements	Serializes measurements to data output stream.
	QueueMeasurementForProcessing	Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys.
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
	RefreshMetadata	Initiates request for metadata refresh for OutputAdapterBase, if implemented.
	RemoveMeasurements	This removes a range of measurements from the internal measurement queue.
	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 OutputAdapterBase and initiates connection cycle to data output stream. (Overrides AdapterBaseStart)
	Stop	Stops this OutputAdapterBase and disconnects from data output stream. (Overrides AdapterBaseStop)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

	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)
	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)
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)
	UnprocessedMeasurements	Event is raised every five seconds allowing host to track total number of unprocessed measurements.

Top

	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

This base class acts as a measurement queue so that output adapters can temporarily go offline without losing any measurements to be processed. Derived classes are expected to override ProcessMeasurements(IMeasurement) to handle queued measurements.

Reference

GSF.TimeSeries.Adapters Namespace