ActionAdapterBase Class

SystemObject
  GSF.TimeSeriesConcentratorBase
    GSF.TimeSeries.AdaptersActionAdapterBase
      GSF.TimeSeries.AdaptersOneSecondDataWindowAdapterBase

public abstract class ActionAdapterBase : ConcentratorBase, 
	IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

Public MustInherit Class ActionAdapterBase
	Inherits ConcentratorBase
	Implements IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus

public ref class ActionAdapterBase abstract : public ConcentratorBase, 
	IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

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

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

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

View Source

	Name	Description
	ActionAdapterBase	Creates a new ActionAdapterBase.

Top

	Name	Description
	AllowPreemptivePublishing	Gets or sets flag that allows system to preemptively publish frames assuming all ExpectedMeasurements have arrived. (Inherited from ConcentratorBase)
	AllowSortsByArrival	Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps to be sorted by arrival time. (Inherited from ConcentratorBase)
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
	AveragePublicationTimePerFrame	Gets the average required frame publication time, in seconds. (Inherited from ConcentratorBase)
	ConnectionInfo	Gets connection info for adapter, if any.
	ConnectionString	Gets or sets key/value pair connection information specific to action adapter.
	DataSource	Gets or sets DataSet based data source available to this ActionAdapterBase.
	DiscardedMeasurements	Gets the total number of measurements that have been discarded because of old timestamps (i.e., measurements that were outside the time deviation tolerance from base time, past or future). (Inherited from ConcentratorBase)
	DownsampledMeasurements	Gets the total number of down-sampled measurements processed by the concentrator. (Inherited from ConcentratorBase)
	DownsamplingMethod	Gets or sets the DownsamplingMethod to be used by the concentrator. (Inherited from ConcentratorBase)
	Enabled	Gets or sets the current enabled state of concentrator. (Inherited from ConcentratorBase)
	ExpectedMeasurements	Gets or sets the expected number of measurements to be assigned to a single frame. (Inherited from ConcentratorBase)
	FramesAheadOfSchedule	Gets the total number of frames ahead of schedule processed by the concentrator. (Inherited from ConcentratorBase)
	FramesPerSecond	Gets or sets the number of frames per second.
	ID	Gets or sets numeric ID associated with this action adapter.
	IgnoreBadTimestamps	Gets or sets flag that determines if bad timestamps (as determined by measurement's timestamp quality) should be ignored when sorting measurements. (Inherited from ConcentratorBase)
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization.
	Initialized	Gets or sets flag indicating if the action adapter has been initialized successfully.
	InputMeasurementKeys	Gets or sets primary keys of input measurements the action adapter expects.
	InputSourceIDs	Gets or sets Source values used to filter input measurement keys.
	IsDisposed	Gets a flag that indicates whether the object has been disposed.
	LagTicks	Gets defined past time deviation tolerance, in ticks. (Inherited from ConcentratorBase)
	LagTime	Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
	LastDiscardedMeasurement	Gets a reference the last IMeasurement that was discarded by the concentrator. (Inherited from ConcentratorBase)
	LastDiscardedMeasurementLatency	Gets the calculated latency of the last IMeasurement that was discarded by the concentrator. (Inherited from ConcentratorBase)
	LastFrame	Gets reference to the last published IFrame. (Inherited from ConcentratorBase)
	LatestMeasurements	Gets reference to the collection of absolute latest received measurement values. (Inherited from ConcentratorBase)
	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 ConcentratorBase)
	MaximumPublicationTimeout	Gets or sets the maximum frame publication timeout in milliseconds, set to Infinite(-1) to wait indefinitely. (Inherited from ConcentratorBase)
	MeasurementsSortedByArrival	Gets the total number of measurements that were sorted by arrival because the measurement reported a bad timestamp quality. (Inherited from ConcentratorBase)
	MinimumMeasurementsToUse	Gets or sets minimum number of input measurements required for adapter. Set to -1 to require all.
	MissedSortsByTimeout	Gets the total number of missed sorts by timeout processed by the concentrator. (Inherited from ConcentratorBase)
	Name	Gets name of the action adapter.
	OutputMeasurements	Gets or sets output measurements that the action adapter will produce, if any.
	OutputSourceIDs	Gets or sets Source values used to filter output measurements.
	PerformTimestampReasonabilityCheck	Gets or sets flag that determines if timestamp reasonability checks should be performed on incoming measurements (i.e., measurement timestamps are compared to system clock for reasonability using LeadTime tolerance). (Inherited from ConcentratorBase)
	ProcessByReceivedTimestamp	Gets or sets flag that determines if concentrator should sort measurements by received time. (Inherited from ConcentratorBase)
	ProcessedMeasurements	Gets the total number of measurements successfully sorted. (Inherited from ConcentratorBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter. (Inherited from ConcentratorBase)
	PublishedFrames	Gets the total number of published frames. (Inherited from ConcentratorBase)
	PublishedMeasurements	Gets the total number of published measurements. (Inherited from ConcentratorBase)
	QueueState	Gets detailed state of concentrator frame queue. (Inherited from ConcentratorBase)
	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, or UtcNow if no measurement timestamps are within time deviation tolerances as specified by the LeadTime value. (Inherited from ConcentratorBase)
	ReceivedMeasurements	Gets the total number of measurements ever requested for sorting. (Inherited from ConcentratorBase)
	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.
	RoundToNearestTimestamp	Gets or sets a value to indicate whether the concentrator should round to the nearest frame timestamp rather than rounding down to the nearest timestamps. (Inherited from ConcentratorBase)
	RunTime	Gets the total amount of time, in seconds, that the concentrator has been active. (Inherited from ConcentratorBase)
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
	ShowConcentratorStatus	Gets flags that determines if ConcentratorBase class status should be included in ActionAdapterBase status.
	StartTime	Gets the UTC time the concentrator was started. (Inherited from ConcentratorBase)
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
	Status	Returns the detailed status of the action adapter. (Overrides ConcentratorBaseStatus)
	StopTime	Gets the UTC time the concentrator was stopped. (Inherited from ConcentratorBase)
	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.
	TicksPerFrame	Gets the number of ticks per frame. (Inherited from ConcentratorBase)
	TimeResolution	Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame. (Inherited from ConcentratorBase)
	TotalPublicationTime	Gets the total number of seconds frames have spent in the publication process since concentrator started. (Inherited from ConcentratorBase)
	TrackLatestMeasurements	Gets or sets flag to start tracking the absolute latest received measurement values. (Inherited from ConcentratorBase)
	UseLocalClockAsRealTime	Gets or sets flag that determines whether or not to use the local clock time as real-time. (Inherited from ConcentratorBase)
	UsePrecisionTimer	Gets or sets flag that determines if precision timer should be used for frame publication. (Inherited from ConcentratorBase)
	WaitHandleExpirations	Gets the total number of wait handle expirations encountered due to delayed precision timer releases. (Inherited from ConcentratorBase)

Top

	Name	Description
	AssignMeasurementToFrame	Assigns IMeasurement to its associated IFrame. (Inherited from ConcentratorBase)
	CreateNewFrame	Creates a new IFrame for the given timestamp. (Inherited from ConcentratorBase)
	Dispose	Releases all the resources used by the ConcentratorBase object. (Inherited from ConcentratorBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the ActionAdapterBase object and optionally releases the managed resources. (Overrides ConcentratorBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExamineQueueState	Examines the concentrator frame queue state of the ActionAdapterBase.
	Finalize	Releases the unmanaged resources before the ConcentratorBase object is reclaimed by GC. (Inherited from ConcentratorBase)
	GetHashCode	Serves as a hash function for the current ActionAdapterBase. (Overrides ObjectGetHashCode)
	GetShortStatus	Gets a short one-line status of this ActionAdapterBase.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes ActionAdapterBase.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MillisecondsFromRealTime	Returns the deviation, in milliseconds, that the given number of ticks is from real-time (i.e., RealTime). (Inherited from ConcentratorBase)
	OnConfigurationChanged	Raises ConfigurationChanged event.
	OnDiscardingMeasurements	Raises the DiscardingMeasurements event. (Inherited from ConcentratorBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event.
	OnNewMeasurements	Raises the NewMeasurements event.
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event.
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event. (Inherited from ConcentratorBase)
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event. (Inherited from ConcentratorBase)
	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.
	OnUnpublishedSamples	Raises the UnpublishedSamples event. (Inherited from ConcentratorBase)
	PublishFrame	Publish IFrame of time-aligned collection of IMeasurement values that arrived within the concentrator's defined LagTime. (Inherited from ConcentratorBase)
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
	ResetStatistics	Resets the statistics of the ActionAdapterBase. (Overrides ConcentratorBaseResetStatistics)
	SecondsFromRealTime	Returns the deviation, in seconds, that the given number of ticks is from real-time (i.e., RealTime). (Inherited from ConcentratorBase)
	SetInitializedState	Manually sets the initialized state of the ActionAdapterBase.
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter.
	SortMeasurement	Sorts the IMeasurement placing the data point in its proper IFrame. (Inherited from ConcentratorBase)
	SortMeasurements	Sorts each IMeasurement placing each data point in its proper IFrame. (Inherited from ConcentratorBase)
	Start	Starts the ActionAdapterBase or restarts it if it is already running. (Overrides ConcentratorBaseStart)
	Stop	Stops the ActionAdapterBase. (Overrides ConcentratorBaseStop)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetMinimumNeededMeasurements	Attempts to retrieve the minimum needed number of measurements from the frame (as specified by MinimumMeasurementsToUse)

Top

	Name	Description
	ConfigurationChanged	Event is raised when adapter is aware of a configuration change.
	DiscardingMeasurements	This event is raised if there are any measurements being discarded during the sorting process. (Inherited from ConcentratorBase)
	Disposed	This event is raised when ConcentratorBase is disposed. (Inherited from ConcentratorBase)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated.
	NewMeasurements	Provides new measurements from action adapter.
	OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated.
	ProcessException	This event is raised if there is an exception encountered while attempting to process a frame in the sample queue. (Inherited from ConcentratorBase)
	StatusMessage	Provides status messages to consumer.
	UnpublishedSamples	This event is raised every 5 seconds allowing consumer to track current number of unpublished seconds of data in the queue. (Inherited from ConcentratorBase)

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 concentrator which time aligns all incoming measurements for proper processing. Derived classes are expected to override PublishFrame(IFrame, Int32) to handle time aligned measurements and call OnNewMeasurements(ICollectionIMeasurement) for any new measurements that may get created.

Reference

GSF.TimeSeries.Adapters Namespace