FacileActionAdapterBase Class

Represents the base class for simple, non-time-aligned, action adapters.

Inheritance Hierarchy

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
      GSF.TimeSeries.StatisticsStatisticsEngine
      GSF.TimeSeries.TransportTemporalClientSubscriptionProxy

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

Syntax

C++

JavaScript

Copy

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

Public MustInherit Class FacileActionAdapterBase
	Inherits AdapterBase
	Implements IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus

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

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

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

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

View Source

The FacileActionAdapterBase type exposes the following members.

Constructors

	Name	Description
	FacileActionAdapterBase	Creates a new instance of the FacileActionAdapterBase class.

Top

Properties

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	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)
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	FallBackOnLocalClock	Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable.
	FramesPerSecond	Gets or sets the frames per second to be used by the FacileActionAdapterBase.
	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 FacileActionAdapterBase expects, if any. (Overrides AdapterBaseInputMeasurementKeys)
	InputSourceIDs	Gets or sets Source values used to filter input measurement keys.
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterBase)
	LagTime	Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
	LatestMeasurements	Gets reference to the collection of absolute latest received measurement values.
	LeadTime	Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
	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)
	RealTime	Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then this function will return UtcNow. Otherwise, this function will return the timestamp of the most recent measurement.
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
	RequestedOutputMeasurementKeys	Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
	RespectInputDemands	Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
	RespectOutputDemands	Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
	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)
	TrackLatestMeasurements	Gets or sets flag to start tracking the absolute latest received measurement values.
	UseLocalClockAsRealTime	Gets or sets flag that determines whether or not to use the local clock time as real time.

Top

Methods

	Name	Description
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the AdapterBase object and optionally releases the managed resources. (Inherited from AdapterBase)
	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 FacileActionAdapterBase. (Overrides AdapterBaseInitialize)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnDiscardingMeasurements	Raises the DiscardingMeasurements event.
	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)
	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)
	OnUnpublishedSamples	Raises the UnpublishedSamples event.
	QueueMeasurementForProcessing	Queues a single measurement for processing.
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing.
	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 the AdapterBase or restarts it if it is already running. (Inherited from AdapterBase)
	Stop	Stops the AdapterBase. (Inherited from 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. (Inherited from AdapterBase)
	DiscardingMeasurements	This event is raised if there are any measurements being discarded during the sorting process.
	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 action 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)
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)
	UnpublishedSamples	This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue.

Top

Fields

	Name	Description
	DefaultFallBackOnLocalClock	Default value for the FallBackOnLocalClock property.
	DefaultFramesPerSecond	Default value for the FramesPerSecond property.
	DefaultLagTime	Default value for the LagTime property.
	DefaultLeadTime	Default value for the LeadTime property.
	DefaultRespectInputDemands	Default value for the RespectInputDemands property.
	DefaultRespectOutputDemands	Default value for the RespectOutputDemands property.
	DefaultTrackLatestMeasurements	Default value for the TrackLatestMeasurements property.
	DefaultUseLocalClockAsRealTime	Default value for the UseLocalClockAsRealTime property.

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

This base class acts on incoming measurements, in a non-time-aligned fashion, for general processing. If derived class needs time-aligned data for processing, the ActionAdapterBase class should be used instead. Derived classes are expected call OnNewMeasurements(ICollectionIMeasurement) for any new measurements that may get created.

Reference

GSF.TimeSeries.Adapters Namespace