Click or drag to resize

ActionAdapterCollection Class

Represents a collection of IActionAdapter implementations.
Inheritance Hierarchy

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.218-beta
Syntax
View Source

The ActionAdapterCollection type exposes the following members.

Constructors
 NameDescription
Public methodActionAdapterCollection Constructs a new instance of the ActionAdapterCollection.
Top
Properties
 NameDescription
Protected propertyAutoInitialize Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection.
(Inherited from AdapterCollectionBaseT)
Public propertyAutoStart Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBaseT)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyConvertReadonlyCollectionsToWritable Gets or sets flag that determines if readonly collections should be converted to writable so published measurement sets can be augmented by filter adapters.
Public propertyCount Gets the number of elements contained in the ICollectionT.
(Inherited from ListCollectionT)
Public propertyDataMember Gets or sets specific data member (e.g., table name) in DataSource used to Initialize this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyDataSource Gets or sets DataSet based data source used to load each IAdapter. Updates to this property will cascade to all items in this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyEnabled Gets or sets enabled state of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyID Gets or sets numeric ID associated with this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyInitializationTimeout Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization.
(Inherited from AdapterCollectionBaseT)
Public propertyInitialized Gets or sets flag indicating if the adapter collection has been initialized successfully.
(Inherited from AdapterCollectionBaseT)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any.
(Inherited from AdapterCollectionBaseT)
Public propertyInputSourceIDs Gets or sets Source values used to filter input measurement keys.
(Inherited from AdapterCollectionBaseT)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterCollectionBaseT)
Public propertyIsReadOnly Gets a value indicating whether the AdapterCollectionBaseT is read-only.
(Inherited from AdapterCollectionBaseT)
Public propertyItem Gets or sets the element at the specified index.
(Inherited from ListCollectionT)
Protected propertyItems Gets a IListT wrapper around the CollectionT.
(Inherited from ListCollectionT)
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterCollectionBaseT)
Protected propertyMonitorTimerEnabled Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyName Gets or sets the name of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterCollectionBaseT will produce, if any.
(Inherited from AdapterCollectionBaseT)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBaseT)
Public propertyProcessedMeasurements Gets the total number of measurements processed thus far by each IAdapter implementation in the AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
(Inherited from AdapterCollectionBaseT)
Public propertyRequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT)
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBaseT)
Public propertyRespectInputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
Public propertyRespectOutputDemands Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterCollectionBaseT)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterCollectionBaseT)
Public propertyStartTime Gets the UTC time this AdapterCollectionBaseT was started.
(Inherited from AdapterCollectionBaseT)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT)
Public propertyStatus Gets the descriptive status of this ActionAdapterCollection.
(Overrides AdapterCollectionBaseTStatus)
Public propertyStopTime Gets the UTC time this AdapterCollectionBaseT was stopped.
(Inherited from AdapterCollectionBaseT)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBaseT)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter collection supports temporal processing.
(Inherited from AdapterCollectionBaseT)
Top
Methods
 NameDescription
Public methodAdd Adds an item to the ICollectionT.
(Inherited from ListCollectionT)
Public methodClear Removes all items from the ICollectionT.
(Inherited from ListCollectionT)
Protected methodClearItems Removes all elements from the CollectionT.
(Inherited from AdapterCollectionBaseT)
Public methodContains Determines whether the ICollectionT contains a specific value.
(Inherited from ListCollectionT)
Public methodCopyTo Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ListCollectionT)
Public methodDispose Releases all the resources used by the AdapterCollectionBaseT object.
(Inherited from AdapterCollectionBaseT)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the AdapterCollectionBaseT object and optionally releases the managed resources.
(Inherited from AdapterCollectionBaseT)
Protected methodDisposeItem Unwires events and disposes of IActionAdapter implementation.
(Overrides AdapterCollectionBaseTDisposeItem(T))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterCollectionBaseT object is reclaimed by GC.
(Inherited from AdapterCollectionBaseT)
Public methodGetEnumerator Returns an enumerator that iterates through the CollectionT.
(Inherited from ListCollectionT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetShortStatus Gets a short one-line status of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Determines the index of a specific item in the IListT.
(Inherited from ListCollectionT)
Public methodInitialize Initializes the ActionAdapterCollection.
(Overrides AdapterCollectionBaseTInitialize)
Protected methodInitializeItem Wires events and initializes new IActionAdapter implementation.
(Overrides AdapterCollectionBaseTInitializeItem(T))
Public methodInsert Inserts an item to the IListT at the specified index.
(Inherited from ListCollectionT)
Protected methodInsertItem Inserts an element into the CollectionT the specified index.
(Inherited from AdapterCollectionBaseT)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnDiscardingMeasurements Raises the DiscardingMeasurements event.
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnNewMeasurements(ICollectionIMeasurement) Raises the NewMeasurements event.
Protected methodOnNewMeasurements(Object, EventArgsICollectionIMeasurement) Raises the NewMeasurements event.
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnRequestTemporalSupport Raises RequestTemporalSupport event.
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterCollectionBaseT)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterCollectionBaseT)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBaseT)
Protected methodOnUnpublishedSamples Raises the UnpublishedSamples event.
Public methodQueueMeasurementsForProcessing Queues a collection of measurements for processing to each IActionAdapter implementation in this ActionAdapterCollection.
Public methodRemove Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ListCollectionT)
Public methodRemoveAt Removes the element at the specified index of the CollectionT.
(Inherited from ListCollectionT)
Protected methodRemoveItem Removes the element at the specified index of the CollectionT.
(Inherited from AdapterCollectionBaseT)
Public methodResetStatistics Resets the statistics of this collection.
(Inherited from AdapterCollectionBaseT)
Protected methodSetItem Assigns a new element to the CollectionT at the specified index.
(Inherited from AdapterCollectionBaseT)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
(Inherited from AdapterCollectionBaseT)
Public methodStart Starts, or restarts, each IAdapter implementation in this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public methodStop Stops each IAdapter implementation in this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryCreateAdapter Attempts to create an IAdapter from the specified DataRow.
(Inherited from AdapterCollectionBaseT)
Protected methodTryGetAdapterTValue Attempts to get the adapter with the specified value given testItem function.
(Inherited from AdapterCollectionBaseT)
Public methodTryGetAdapterByID Attempts to get the adapter with the specified id.
(Inherited from AdapterCollectionBaseT)
Public methodTryGetAdapterByName Attempts to get the adapter with the specified name.
(Inherited from AdapterCollectionBaseT)
Public methodTryInitializeAdapterByID Attempts to initialize (or reinitialize) an individual IAdapter based on its ID.
(Inherited from AdapterCollectionBaseT)
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBaseT)
Public eventDiscardingMeasurements This event is raised if there are any measurements being discarded during the sorting process.
Public eventDisposed Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed.
(Inherited from AdapterCollectionBaseT)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterCollectionBaseT)
Public eventNewMeasurements This event will be raised when there are new measurements available from the action adapter.
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterCollectionBaseT)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterCollectionBaseT)
Public eventRequestTemporalSupport Event is raised when temporal support is requested.
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterCollectionBaseT)
Public eventUnpublishedSamples This event is raised every five seconds allowing consumer to track current number of unpublished seconds of data in the queue.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetMeasurementRecord Gets measurement record, creating it if needed.
(Defined by MetadataHelpers)
Public Extension MethodGetParentDevice Gets ID of parent device, creating or updating record if needed, for the current IAdapter instance.
(Defined by MetadataHelpers)
Public Extension MethodInputMeasurementKeys Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions)
Public Extension MethodLookupDevice Looks up associated device acronym and ID from provided signalID.
(Defined by MetadataHelpers)
Public Extension MethodLookupMeasurementKey Looks up or creates measurement key based on provided signalID.
(Defined by MetadataHelpers)
Public Extension MethodLookupPointTag Looks up point tag name from provided signalID.
(Defined by MetadataHelpers)
Public Extension MethodLookupSignalReference Looks up signal reference from provided signalID.
(Defined by MetadataHelpers)
Public Extension MethodOnConfigurationChanged Notifies host system of configuration changes.
(Defined by MetadataHelpers)
Public Extension MethodOutputMeasurementKeys Returns the MeasurementKey values of the IAdapter output measurements.
(Defined by IAdapterExtensions)
Public Extension MethodPointTagExists Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers)
Public Extension MethodSignalIDExists Determines if signalID exists in local configuration.
(Defined by MetadataHelpers)
Public Extension MethodSignalReferenceExists Determines if signalReference exists in local configuration.
(Defined by MetadataHelpers)
Public Extension MethodTemporalConstraintIsDefined 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)
Public Extension MethodWaitForSignalsToLoad Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers)
Top
See Also