|
Action
|
Represents a collection of IActionAdapter implementations.
Inheritance Hierarchy
System.Object
System.Collections.ObjectModel.Collection<IActionAdapter>
GSF.Collections.ListCollection<IActionAdapter>
GSF.TimeSeries.Adapters.AdapterCollectionBase<IActionAdapter>
GSF.TimeSeries.Adapters.ActionAdapterCollection
GSF.TimeSeries.Adapters.IndependentActionAdapterManagerBase<TAdapter>
GSF.TimeSeries.Transport.DataPublisher
System.Collections.ObjectModel.Collection<IActionAdapter>
GSF.Collections.ListCollection<IActionAdapter>
GSF.TimeSeries.Adapters.AdapterCollectionBase<IActionAdapter>
GSF.TimeSeries.Adapters.ActionAdapterCollection
GSF.TimeSeries.Adapters.IndependentActionAdapterManagerBase<TAdapter>
GSF.TimeSeries.Transport.DataPublisher
Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.239-beta
Syntaxpublic class ActionAdapterCollection : AdapterCollectionBase<IActionAdapter>, IActionAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus
The ActionAdapterCollection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ActionAdapterCollection | Constructs a new instance of the ActionAdapterCollection. |
Properties| Name | Description | |
|---|---|---|
 | AutoInitialize |
Gets flag that determines if IAdapter implementations are automatically initialized
when they are added to the collection.
(Inherited from AdapterCollectionBase<T>) |
 | AutoStart |
Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBase<T>) |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| 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. |
| Count |
Gets the number of elements contained in the ICollection<T>.
(Inherited from ListCollection<T>) |
| DataMember |
Gets or sets specific data member (e.g., table name) in DataSource used to Initialize() this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| DataSource |
Gets or sets DataSet based data source used to load each IAdapter.
Updates to this property will cascade to all items in this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| Enabled |
Gets or sets enabled state of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| ID |
Gets or sets numeric ID associated with this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| InitializationTimeout |
Gets or sets the default adapter time that represents the maximum time system will wait during Start() for initialization.
(Inherited from AdapterCollectionBase<T>) |
| Initialized |
Gets or sets flag indicating if the adapter collection has been initialized successfully.
(Inherited from AdapterCollectionBase<T>) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the AdapterCollectionBase<T> expects, if any.
(Inherited from AdapterCollectionBase<T>) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurement keys.
(Inherited from AdapterCollectionBase<T>) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterCollectionBase<T>) |
| IsReadOnly |
Gets a value indicating whether the AdapterCollectionBase<T> is read-only.
(Inherited from AdapterCollectionBase<T>) |
| Item |
Gets or sets the element at the specified index.
(Inherited from ListCollection<T>) |
| Items |
Gets a IList<T> wrapper around the Collection<T>.
(Inherited from ListCollection<T>) |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterCollectionBase<T>) |
| MonitorTimerEnabled |
Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| Name |
Gets or sets the name of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| OutputMeasurements |
Gets or sets output measurements that the AdapterCollectionBase<T> will produce, if any.
(Inherited from AdapterCollectionBase<T>) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBase<T>) |
| ProcessedMeasurements |
Gets the total number of measurements processed thus far by each IAdapter implementation
in the AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
(Inherited from AdapterCollectionBase<T>) |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBase<T>) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBase<T>) |
| 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 AdapterCollectionBase<T>) |
| Settings |
Gets settings Dictionary<TKey, TValue> parsed when ConnectionString was assigned.
(Inherited from AdapterCollectionBase<T>) |
| StartTime |
Gets the UTC time this AdapterCollectionBase<T> was started.
(Inherited from AdapterCollectionBase<T>) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBase<T>) |
| Status |
Gets the descriptive status of this ActionAdapterCollection.
(Overrides AdapterCollectionBase<T>.Status) |
| StopTime |
Gets the UTC time this AdapterCollectionBase<T> was stopped.
(Inherited from AdapterCollectionBase<T>) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBase<T>) |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter collection supports temporal processing.
(Inherited from AdapterCollectionBase<T>) |
Methods| Name | Description | |
|---|---|---|
| Add |
Adds an item to the ICollection<T>.
(Inherited from ListCollection<T>) |
| Clear |
Removes all items from the ICollection<T>.
(Inherited from ListCollection<T>) |
 | ClearItems |
Removes all elements from the Collection<T>.
(Inherited from AdapterCollectionBase<T>) |
| Contains |
Determines whether the ICollection<T> contains a specific value.
(Inherited from ListCollection<T>) |
| CopyTo |
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
(Inherited from ListCollection<T>) |
| Dispose() |
Releases all the resources used by the AdapterCollectionBase<T> object.
(Inherited from AdapterCollectionBase<T>) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the AdapterCollectionBase<T> object and optionally releases the managed resources.
(Inherited from AdapterCollectionBase<T>) |
| DisposeItem |
Unwires events and disposes of IActionAdapter implementation.
(Overrides AdapterCollectionBase<T>.DisposeItem(T)) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the AdapterCollectionBase<T> object is reclaimed by GC.
(Inherited from AdapterCollectionBase<T>) |
| GetEnumerator |
Returns an enumerator that iterates through the Collection<T>.
(Inherited from ListCollection<T>) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetShortStatus |
Gets a short one-line status of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IndexOf |
Determines the index of a specific item in the IList<T>.
(Inherited from ListCollection<T>) |
| Initialize |
Initializes the ActionAdapterCollection.
(Overrides AdapterCollectionBase<T>.Initialize()) |
| InitializeItem |
Wires events and initializes new IActionAdapter implementation.
(Overrides AdapterCollectionBase<T>.InitializeItem(T)) |
| Insert |
Inserts an item to the IList<T> at the specified index.
(Inherited from ListCollection<T>) |
| InsertItem |
Inserts an element into the Collection<T> the specified index.
(Inherited from AdapterCollectionBase<T>) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBase<T>) |
| OnDiscardingMeasurements | Raises the DiscardingMeasurements event. |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBase<T>) |
| OnNewMeasurements(ICollection<IMeasurement>) | Raises the NewMeasurements event. |
| OnNewMeasurements(Object, EventArgs<ICollection<IMeasurement>>) | Raises the NewMeasurements event. |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBase<T>) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterCollectionBase<T>) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterCollectionBase<T>) |
| OnRequestTemporalSupport | Raises RequestTemporalSupport event. |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from AdapterCollectionBase<T>) |
| OnStatusMessage(String, Object[]) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterCollectionBase<T>) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBase<T>) |
| OnUnpublishedSamples | Raises the UnpublishedSamples event. |
| QueueMeasurementsForProcessing | Queues a collection of measurements for processing to each IActionAdapter implementation in this ActionAdapterCollection. |
| Remove |
Removes the first occurrence of a specific object from the ICollection<T>.
(Inherited from ListCollection<T>) |
| RemoveAt |
Removes the element at the specified index of the Collection<T>.
(Inherited from ListCollection<T>) |
| RemoveItem |
Removes the element at the specified index of the Collection<T>.
(Inherited from AdapterCollectionBase<T>) |
| ResetStatistics |
Resets the statistics of this collection.
(Inherited from AdapterCollectionBase<T>) |
| SetItem |
Assigns a new element to the Collection<T> at the specified index.
(Inherited from AdapterCollectionBase<T>) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
(Inherited from AdapterCollectionBase<T>) |
| Start |
Starts, or restarts, each IAdapter implementation in this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| Stop |
Stops each IAdapter implementation in this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryCreateAdapter |
Attempts to create an IAdapter from the specified DataRow.
(Inherited from AdapterCollectionBase<T>) |
| TryGetAdapter<TValue> |
Attempts to get the adapter with the specified value given testItem function.
(Inherited from AdapterCollectionBase<T>) |
| TryGetAdapterByID |
Attempts to get the adapter with the specified id.
(Inherited from AdapterCollectionBase<T>) |
| TryGetAdapterByName |
Attempts to get the adapter with the specified name.
(Inherited from AdapterCollectionBase<T>) |
| TryInitializeAdapterByID |
Attempts to initialize (or reinitialize) an individual IAdapter based on its ID.
(Inherited from AdapterCollectionBase<T>) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBase<T>) |
| DiscardingMeasurements | This event is raised if there are any measurements being discarded during the sorting process. |
| Disposed |
Event is raised when this AdapterCollectionBase<T> is disposed or an IAdapter in the collection is disposed.
(Inherited from AdapterCollectionBase<T>) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterCollectionBase<T>) |
| NewMeasurements | This event will be raised when there are new measurements available from the action adapter. |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from AdapterCollectionBase<T>) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from AdapterCollectionBase<T>) |
| RequestTemporalSupport | Event is raised when temporal support is requested. |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterCollectionBase<T>) |
| UnpublishedSamples | This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefault<T> |
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) |
See Also