IndependentActionAdapterManagerBaseTAdapter Class

Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of action adapters.

Definition

Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.128 -- Release Build+e2476c52e94864f123f37e60764c948e49eb89eb
Inheritance
Object    CollectionIActionAdapter    ListCollectionIActionAdapter    AdapterCollectionBaseIActionAdapter    ActionAdapterCollection    IndependentActionAdapterManagerBaseTAdapter
Implements
IProvideStatus, ISupportLifecycle, IAdapter, IAdapterCollection, IIndependentAdapterManager, ICollectionIAdapter, IEnumerableIAdapter, IListIAdapter, IEnumerable, IDisposable

Type Parameters

TAdapter

[Missing <typeparam name="TAdapter"/> documentation for "T:Gemstone.Timeseries.Adapters.IndependentActionAdapterManagerBase`1"]

Constructors

IndependentActionAdapterManagerBaseTAdapter Creates a new IndependentActionAdapterManagerBaseTAdapter.

Properties

AdapterIDCounter Gets or sets current adapter ID counter.
AlternateTagTemplate Gets or sets template for output measurement alternate tag names.
AutoInitialize Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection.
(Inherited from AdapterCollectionBaseT)
AutoReparseConnectionString Gets or sets flag that determines if the IndependentActionAdapterManagerBaseTAdapter adapter ConnectionString should be automatically parsed every time the DataSource is updated without requiring adapter to be reinitialized. Defaults to true to allow child adapters to come and go based on updates to system configuration.
AutoStart Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBaseT)
ConfigurationReloadWaitAttempts Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
ConfigurationReloadWaitTimeout Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
ConnectionString Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
ConvertReadonlyCollectionsToWritable Gets or sets flag that determines if readonly collections should be converted to writable so published measurement sets can be augmented by filter adapters.
(Inherited from ActionAdapterCollection)
Count Gets the number of elements contained in the ICollectionT.
(Inherited from ListCollectionIActionAdapter)
CurrentAdapterIndex Gets adapter index currently being processed.
CurrentDeviceID Gets associated device ID for CurrentAdapterIndex, if any, for measurement generation. If overridden to provide custom device ID, ParentDeviceAcronymTemplate should be set to null so no parent device is created.
CurrentOutputIndex Gets adapter output index currently being processed.
CustomAdapterSettings Gets any custom adapter settings to be added to each adapter connection string. Can be used to add settings that are custom per adapter.
DatabaseConnectionString Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
DatabaseProviderString Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
DataMember Gets or sets specific data member (e.g., table name) in DataSource used to Initialize this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
DataSource Gets or sets DataSet based data source used to load each IAdapter. Updates to this property will cascade to all adapters in this IndependentActionAdapterManagerBaseTAdapter.
(Overrides AdapterCollectionBaseTDataSource)
DescriptionTemplate Gets or sets template for output measurement descriptions.
Enabled Gets or sets enabled state of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
FramesPerSecond Gets or sets the number of frames per second applied to each adapter.
ID Gets or sets numeric ID associated with this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
InitializationTimeout Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization.
(Inherited from AdapterCollectionBaseT)
Initialized Gets or sets flag indicating if the adapter collection has been initialized successfully.
(Inherited from AdapterCollectionBaseT)
InputMeasurementIndexUsedForName Gets or sets the index into the per adapter input measurements to use for target adapter name.
InputMeasurementKeys Gets or sets primary keys of input measurements for the IndependentActionAdapterManagerBaseTAdapter.
(Overrides AdapterCollectionBaseTInputMeasurementKeys)
InputMeasurementKeyTypes Gets input measurement SignalType's for each of the InputMeasurementKeys, if any.
InputSourceIDs Gets or sets Source values used to filter input measurement keys.
(Inherited from AdapterCollectionBaseT)
IsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterCollectionBaseT)
IsReadOnly Gets a value indicating whether the AdapterCollectionBaseT is read-only.
(Inherited from AdapterCollectionBaseT)
Item(Int32) Gets or sets the element at the specified index.
(Inherited from ListCollectionIActionAdapter)
Items Gets a IListT wrapper around the CollectionT.
(Inherited from ListCollectionIActionAdapter)
LagTime Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
LeadTime Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
Log Log messages generated by an adapter.
(Inherited from AdapterCollectionBaseT)
MonitorTimerEnabled Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Name Gets or sets the name of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
OutputMeasurements Gets or sets output measurements that the IndependentActionAdapterManagerBaseTAdapter will produce, if any.
(Overrides AdapterCollectionBaseTOutputMeasurements)
OutputMeasurementTypes Gets output measurement SignalType's for each of the OutputMeasurements, if any.
OutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBaseT)
ParentDeviceAcronymTemplate Gets or sets template for the parent device acronym used to group associated output measurements.
PerAdapterInputCount Gets number of input measurement required by each adapter. If value is not constant, use CurrentAdapterIndex to determine input count for adapter at current index.
PerAdapterOutputNames Gets output measurement names to use for each adapter.
PointTagTemplate Gets or sets template for output measurement point tag names.
ProcessedMeasurements Gets the total number of measurements processed thus far by each IAdapter implementation in the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
ProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
(Inherited from AdapterCollectionBaseT)
RequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT)
RequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT)
RespectInputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from ActionAdapterCollection)
RespectOutputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from ActionAdapterCollection)
RunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterCollectionBaseT)
Settings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterCollectionBaseT)
SignalReferenceTemplate Gets or sets template for output measurement signal reference names.
SignalType Gets or sets default signal type to use for all output measurements when SignalTypes array is not defined.
SignalTypes Gets per adapter signal type for output measurements, used when each output needs to be a different type.
SourceMeasurementTable Gets or sets the source measurement table to use for configuration.
StartTime Gets the UTC time this AdapterCollectionBaseT was started.
(Inherited from AdapterCollectionBaseT)
StartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT)
Status Returns the detailed status of the IndependentActionAdapterManagerBaseTAdapter.
(Overrides ActionAdapterCollectionStatus)
StopTime Gets the UTC time this AdapterCollectionBaseT was stopped.
(Inherited from AdapterCollectionBaseT)
StopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT)
SupportsTemporalProcessing Gets the flag indicating if this adapter collection supports temporal processing.
(Inherited from AdapterCollectionBaseT)
TargetHistorianAcronym Gets or sets the target historian acronym for output measurements.

Methods

Add(T1) Adds an item to the ICollectionT.
(Inherited from ListCollectionIActionAdapter)
Clear Removes all items from the ICollectionT.
(Inherited from ListCollectionIActionAdapter)
ClearItems Removes all elements from the CollectionT.
(Inherited from AdapterCollectionBaseT)
ConfigurationReloaded Notifies derived classes that configuration has been reloaded
Contains(T1) Determines whether the ICollectionT contains a specific value.
(Inherited from ListCollectionIActionAdapter)
CopyTo(T1[], Int32) Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ListCollectionIActionAdapter)
Dispose Releases all the resources used by the AdapterCollectionBaseT object.
(Inherited from AdapterCollectionBaseT)
Dispose(Boolean) Releases the unmanaged resources used by the IndependentActionAdapterManagerBaseTAdapter object and optionally releases the managed resources.
(Overrides AdapterCollectionBaseTDispose(Boolean))
DisposeItem Unwires events and disposes of IActionAdapter implementation.
(Inherited from ActionAdapterCollection)
EnumerateAdapters Enumerates child adapters.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Finalize Releases the unmanaged resources before the AdapterCollectionBaseT object is reclaimed by GC.
(Inherited from AdapterCollectionBaseT)
GetAdapterStatus Gets subscriber information for specified client connection.
GetConfiguredConnection Gets configured database connection.
GetEnumerator Returns an enumerator that iterates through the CollectionT.
(Inherited from ListCollectionIActionAdapter)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetShortStatus Gets a short one-line status of this IndependentActionAdapterManagerBaseTAdapter.
(Overrides AdapterCollectionBaseTGetShortStatus(Int32))
GetTypeGets the Type of the current instance.
(Inherited from Object)
IndexOf(T1) Determines the index of a specific item in the IListT.
(Inherited from ListCollectionIActionAdapter)
Initialize Initializes the IndependentActionAdapterManagerBaseTAdapter.
(Overrides ActionAdapterCollectionInitialize)
InitializeChildAdapterManagement Initializes management operations for child adapters based on inputs. Derived classes should override ParseConnectionString and call this method when AutoReparseConnectionString is true (the default).
InitializeItem Wires events and initializes new IActionAdapter implementation.
(Inherited from ActionAdapterCollection)
Insert(Int32, T1) Inserts an item to the IListT at the specified index.
(Inherited from ListCollectionIActionAdapter)
InsertItem Inserts an element into the CollectionT the specified index.
(Inherited from AdapterCollectionBaseT)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBaseT)
OnDiscardingMeasurements Raises the DiscardingMeasurements event.
(Inherited from ActionAdapterCollection)
OnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBaseT)
OnNewMeasurements(ICollectionIMeasurement) Raises the NewMeasurements event.
(Inherited from ActionAdapterCollection)
OnNewMeasurements(Object, EventArgsICollectionIMeasurement) Raises the NewMeasurements event.
(Inherited from ActionAdapterCollection)
OnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBaseT)
OnProcessException Raises the ProcessException event.
(Inherited from AdapterCollectionBaseT)
OnRequestTemporalSupport Raises RequestTemporalSupport event.
(Inherited from ActionAdapterCollection)
OnStatusMessage Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBaseT)
OnUnpublishedSamples Raises the UnpublishedSamples event.
(Inherited from ActionAdapterCollection)
ParseConnectionString Parses connection string. Derived classes should override for custom connection string parsing and call the InitializeChildAdapterManagement(MeasurementKey) method when AutoReparseConnectionString is true (the default).
QueueMeasurementsForProcessing Queues a collection of measurements for processing to each IActionAdapter connected to this IndependentActionAdapterManagerBaseTAdapter.
(Overrides ActionAdapterCollectionQueueMeasurementsForProcessing(IEnumerableIMeasurement))
RecalculateRoutingTables Recalculates routing tables.
Remove(T1) Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ListCollectionIActionAdapter)
RemoveAt(Int32) Removes the element at the specified index of the CollectionT.
(Inherited from ListCollectionIActionAdapter)
RemoveItem Removes the element at the specified index of the CollectionT.
(Inherited from AdapterCollectionBaseT)
ResetStatistics Resets the statistics of this collection.
(Inherited from AdapterCollectionBaseT)
SetItem Assigns a new element to the CollectionT at the specified index.
(Inherited from AdapterCollectionBaseT)
SetTemporalConstraint Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
(Inherited from AdapterCollectionBaseT)
Start Starts, or restarts, each IAdapter implementation in this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Stop Stops each IAdapter implementation in this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryCreateAdapter Attempts to create an IAdapter from the specified DataRow.
(Inherited from AdapterCollectionBaseT)
TryGetAdapterTValue Attempts to get the adapter with the specified value given testItem function.
(Inherited from AdapterCollectionBaseT)
TryGetAdapterByID Attempts to get the adapter with the specified id.
(Inherited from AdapterCollectionBaseT)
TryGetAdapterByName Attempts to get the adapter with the specified name.
(Inherited from AdapterCollectionBaseT)
TryInitializeAdapterByID Attempts to initialize (or reinitialize) an individual IAdapter based on its ID.
(Inherited from AdapterCollectionBaseT)
ValidateEvenInputCount Validates that an even number of inputs are provided for specified PerAdapterInputCount.

Events

ConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBaseT)
DiscardingMeasurements This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from ActionAdapterCollection)
Disposed Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed.
(Inherited from AdapterCollectionBaseT)
InputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterCollectionBaseT)
NewMeasurements This event will be raised when there are new measurements available from the action adapter.
(Inherited from ActionAdapterCollection)
OutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterCollectionBaseT)
ProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterCollectionBaseT)
RequestTemporalSupport Event is raised when temporal support is requested.
(Inherited from ActionAdapterCollection)
StatusMessage Provides status messages to consumer.
(Inherited from AdapterCollectionBaseT)
UnpublishedSamples This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
(Inherited from ActionAdapterCollection)

Fields

DefaultFramesPerSecond Defines the default value for the FramesPerSecond.
DefaultLagTime Defines the default value for the LagTime.
DefaultLeadTime Defines the default value for the LeadTime.

Extension Methods

FindAdapter Finds child adapter with specified adapterName.
(Defined by IndependentAdapterManagerExtensions)
GetMeasurementRecord Gets measurement record, creating it if needed.
(Defined by IndependentAdapterManagerExtensions)
InputMeasurementKeys Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions)
InputMeasurementKeysIAdapter Gets a distinct list of input measurement keys for all of the provided adapters.
(Defined by IAdapterExtensions)
LookupDevice Lookups up associated device name from provided signalID.
(Defined by IndependentAdapterManagerExtensions)
LookupPhasorLabel Lookups up associated phasor label from provided signalID.
(Defined by IndependentAdapterManagerExtensions)
LookupPointTag Lookups up point tag name from provided signalID.
(Defined by IndependentAdapterManagerExtensions)
OutputMeasurementKeys Returns the MeasurementKey values of the IAdapter output measurements.
(Defined by IAdapterExtensions)
OutputMeasurementKeysIAdapter Gets a distinct list of output measurement keys for all of the provided adapters.
(Defined by IAdapterExtensions)
SignalIDExists Determines if signalID exists in local configuration.
(Defined by IndependentAdapterManagerExtensions)
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 IndependentAdapterManagerExtensions)

See Also