Click or drag to resize

IndependentActionAdapterManagerBaseTAdapter, TInitalizationModel Class

Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of action adapters with parallel intialization and Models to store input/ouput relations.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionIActionAdapter
    GSF.CollectionsListCollectionIActionAdapter
      GSF.TimeSeries.AdaptersAdapterCollectionBaseIActionAdapter
        GSF.TimeSeries.AdaptersActionAdapterCollection
          GSF.TimeSeries.AdaptersIndependentActionAdapterManagerBaseTAdapter
            GSF.TimeSeries.AdaptersIndependentActionAdapterManagerBaseTAdapter, TInitalizationModel

Namespace:  GSF.TimeSeries.Adapters
Assembly:  GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.3.380-beta
Syntax
public abstract class IndependentActionAdapterManagerBase<TAdapter, TInitalizationModel> : IndependentActionAdapterManagerBase<TAdapter>
where TAdapter : new(), IAdapter
where TInitalizationModel : class, new()
Request Example View Source

Type Parameters

TAdapter
TInitalizationModel

The IndependentActionAdapterManagerBaseTAdapter, TInitalizationModel type exposes the following members.

Constructors
  NameDescription
Protected methodIndependentActionAdapterManagerBaseTAdapter, TInitalizationModel
Initializes a new instance of the IndependentActionAdapterManagerBaseTAdapter, TInitalizationModel class
Top
Properties
  NameDescription
Public propertyAdapterIDCounter
Gets or sets current adapter ID counter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyAlternateTagTemplate
Gets or sets template for output measurement alternate tag names.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Protected propertyAutoInitialize
Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection.
(Inherited from AdapterCollectionBaseT.)
Protected propertyAutoReparseConnectionString
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.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyAutoStart
Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBaseT.)
Public propertyConfigurationReloadWaitAttempts
Gets or sets the total number of attempts to wait for system configuration reloads when waiting for configuration updates to be available.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyConfigurationReloadWaitTimeout
Gets or sets the wait timeout, in milliseconds, that system wait for system configuration reload to complete.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyConnectionString (Inherited from AdapterCollectionBaseT.)
Public propertyCount (Inherited from ListCollectionT.)
Public propertyCurrentAdapterIndex
Gets adapter index currently being processed.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyCurrentDeviceID
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.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyCurrentOutputIndex
Gets adapter output index currently being processed.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyCustomAdapterSettings
Gets any custom adapter settings to be added to each adapter connection string. Can be used to add settings that are custom per adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyDatabaseConnectionString
Gets or sets the connection string used for database operations. Leave blank to use local configuration database defined in "systemSettings".
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyDatabaseProviderString
Gets or sets the provider string used for database operations. Defaults to a SQL Server provider string.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyDataMember (Inherited from AdapterCollectionBaseT.)
Public propertyDataSource (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyDescriptionTemplate
Gets or sets template for output measurement descriptions.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyEnabled (Inherited from AdapterCollectionBaseT.)
Public propertyFramesPerSecond
Gets or sets the number of frames per second applied to each adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyID (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 propertyInputMeasurementIndexUsedForName
Gets or sets the index into the per adapter input measurements to use for target adapter name.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyInputMeasurementKeys (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyInputMeasurementKeyTypes
Gets input measurement SignalType's for each of the InputMeasurementKeys, if any.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
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 (Inherited from AdapterCollectionBaseT.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from ListCollectionT.)
Protected propertyItems (Inherited from ListCollectionT.)
Public propertyLagTime
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyLeadTime
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second) applied to each adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Protected propertyLog
Log messages generated by an adapter.
(Inherited from AdapterCollectionBaseT.)
Protected propertyMonitorTimerEnabled (Inherited from AdapterCollectionBaseT.)
Public propertyName (Inherited from AdapterCollectionBaseT.)
Public propertyOutputMeasurements (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyOutputMeasurementTypes
Gets output measurement SignalType's for each of the OutputMeasurements, if any.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyOutputSourceIDs
Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBaseT.)
Public propertyParentDeviceAcronymTemplate
Gets or sets template for the parent device acronym used to group associated output measurements.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyPerAdapterInputCount
Gets number of input measurement required by each adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyPerAdapterOutputNames
Gets output measurement names to use for each adapter.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyPointTagTemplate
Gets or sets template for output measurement point tag names.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyProcessedMeasurements (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.
(Inherited from ActionAdapterCollection.)
Public propertyRespectOutputDemands
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from ActionAdapterCollection.)
Public propertyRunTime
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterCollectionBaseT.)
Public propertySettings (Inherited from AdapterCollectionBaseT.)
Public propertySignalReferenceTemplate
Gets or sets template for output measurement signal reference names.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertySignalType
Gets or sets default signal type to use for all output measurements when SignalTypes array is not defined.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertySignalTypes
Gets per adapter signal type for output measurements, used when each output needs to be a different type.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertySourceMeasurementTable
Gets or sets the source measurement table to use for configuration.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public propertyStartTime (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
Returns the detailed status of the IndependentActionAdapterManagerBaseTAdapter, TInitalizationModel.
(Overrides IndependentActionAdapterManagerBaseTAdapterStatus.)
Public propertyStopTime (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.)
Public propertyTargetHistorianAcronym
Gets or sets the target historian acronym for output measurements.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Top
Methods
  NameDescription
Public methodAdd (Inherited from ListCollectionT.)
Protected methodAddInitializitonModel
This function genereates a new Initialization model based on a list of inputs and outputs
Public methodClear (Inherited from ListCollectionT.)
Protected methodClearItems (Inherited from AdapterCollectionBaseT.)
Public methodConfigurationReloaded
Notifies derived classes that configuration has been reloaded
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodContains (Inherited from ListCollectionT.)
Public methodCopyTo (Inherited from ListCollectionT.)
Public methodDispose (Inherited from AdapterCollectionBaseT.)
Protected methodDispose(Boolean) (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Protected methodDisposeItem
Unwires events and disposes of IActionAdapter implementation.
(Inherited from ActionAdapterCollection.)
Public methodEnumerateAdapters
Enumerates child adapters.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Inherited from AdapterCollectionBaseT.)
Public methodGetAdapterStatus
Gets subscriber information for specified client connection.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodGetConfiguredConnection
Gets configured database connection.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodGetEnumerator (Inherited from ListCollectionT.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetOutputsFromInitializationModel
Generates a list of outputs based on a Initialization Model
Public methodGetShortStatus (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf (Inherited from ListCollectionT.)
Public methodInitialize (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Protected methodInitializeChildAdapterManagement
Initializes management operations for child adapters based on inputs.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Protected methodInitializeItem
Wires events and initializes new IActionAdapter implementation.
(Inherited from ActionAdapterCollection.)
Public methodInsert (Inherited from ListCollectionT.)
Protected methodInsertItem (Inherited from AdapterCollectionBaseT.)
Protected methodMapInitializationModel
Function that maps Inputs to a new [!:TInitalizationModel] for finding existing mappings.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigurationChanged
Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBaseT.)
Protected methodOnDiscardingMeasurements
Raises the DiscardingMeasurements event.
(Inherited from ActionAdapterCollection.)
Protected methodOnInputMeasurementKeysUpdated (Inherited from AdapterCollectionBaseT.)
Protected methodOnNewMeasurements
Raises the NewMeasurements event.
(Inherited from ActionAdapterCollection.)
Protected methodOnOutputMeasurementsUpdated (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.
(Inherited from ActionAdapterCollection.)
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.
(Inherited from ActionAdapterCollection.)
Public methodParseConnectionString
Parses connection string. Derived classes should override for custom connection string parsing.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodQueueMeasurementsForProcessing (Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodRecalculateRoutingTables
Recalculates routing tables.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
Public methodRemove (Inherited from ListCollectionT.)
Public methodRemoveAt (Inherited from ListCollectionT.)
Protected methodRemoveItem (Inherited from AdapterCollectionBaseT.)
Public methodResetStatistics
Resets the statistics of this collection.
(Inherited from AdapterCollectionBaseT.)
Protected methodSetItem (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 (Inherited from AdapterCollectionBaseT.)
Public methodStop (Inherited from AdapterCollectionBaseT.)
Public methodToString
Returns 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.)
Protected methodValidateEvenInputCount
Validates that an even number of inputs are provided for specified PerAdapterInputCount.
(Inherited from IndependentActionAdapterManagerBaseTAdapter.)
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.
(Inherited from ActionAdapterCollection.)
Public eventDisposed (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.
(Inherited from ActionAdapterCollection.)
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.
(Inherited from ActionAdapterCollection.)
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.
(Inherited from ActionAdapterCollection.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetEnumValueOrDefault(Type, Object)Overloaded.
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions.)
Public Extension MethodGetEnumValueOrDefaultT(Object)Overloaded.
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions.)
Top
See Also