IActionAdapter Interface

Represents the abstract interface for any action adapter.

Definition

Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.128 -- Release Build+e2476c52e94864f123f37e60764c948e49eb89eb

C#View Source Request Example

public interface IActionAdapter : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus

VBView Source Request Example

Public Interface IActionAdapter
	Inherits IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

C++View Source Request Example

public interface class IActionAdapter : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus

JavaScriptView Source Request Example

Gemstone.Timeseries.Adapters.IActionAdapter = function();
Gemstone.Timeseries.Adapters.IActionAdapter.createInterface('Gemstone.Timeseries.Adapters.IActionAdapter');

Implements: IProvideStatus, ISupportLifecycle, IAdapter, IDisposable

Properties

AutoStart	Gets or sets flag indicating if adapter should automatically start or connect on demand. (Inherited from IAdapter)
ConnectionInfo	Gets connection info for adapter, if any. (Inherited from IAdapter)
ConnectionString	Gets or sets key/value pair connection information specific to IAdapter. (Inherited from IAdapter)
DataSource	Gets or sets DataSet based data source available to IAdapter. (Inherited from IAdapter)
Enabled	Gets or sets a boolean value that indicates whether the object is enabled. (Inherited from ISupportLifecycle)
ID	Gets or sets the numeric ID associated with this IAdapter. (Inherited from IAdapter)
InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization. (Inherited from IAdapter)
Initialized	Gets or sets flag indicating if the adapter has been initialized successfully. (Inherited from IAdapter)
InputMeasurementKeys	Gets or sets primary keys of input measurements the adapter expects. (Inherited from IAdapter)
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 ISupportLifecycle)
Name	Gets or sets name of this IAdapter. (Inherited from IAdapter)
OutputMeasurements	Gets or sets output measurements that the adapter will produce, if any. (Inherited from IAdapter)
OutputSourceIDs	Gets or sets Source values used to filter output measurements.
ProcessedMeasurements	Gets the total number of measurements processed thus far by the IAdapter. (Inherited from IAdapter)
ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter. (Inherited from IAdapter)
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.
Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from IAdapter)
StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from IAdapter)
Status	Gets the current status details about object providing status information. (Inherited from IProvideStatus)
StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from IAdapter)
SupportsTemporalProcessing	Gets the flag indicating if this adapter supports temporal processing. (Inherited from IAdapter)

Methods

Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
GetShortStatus	Gets a short one-line adapter status. (Inherited from IAdapter)
Initialize	Initializes the state of the object. (Inherited from ISupportLifecycle)
QueueMeasurementsForProcessing	Queues measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys.
SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from IAdapter)
Start	Starts the adapter, if it is not already running. (Inherited from IAdapter)
Stop	Stops the adapter. (Inherited from IAdapter)

Events

ConfigurationChanged	Event is raised when adapter is aware of a configuration change. (Inherited from IAdapter)
DiscardingMeasurements	This event is raised if there are any measurements being discarded during the sorting process.
Disposed	Raised after the source object has been properly disposed. (Inherited from ISupportLifecycle)
InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated. (Inherited from IAdapter)
NewMeasurements	Provides new measurements from action adapter.
OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated. (Inherited from IAdapter)
ProcessException	Event is raised when there is an exception encountered while processing. (Inherited from IAdapter)
StatusMessage	Provides status messages to consumer. (Inherited from IAdapter)
UnpublishedSamples	This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.

Extension Methods

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)