|
Independent
|
Represents an adapter base class that provides functionality to manage and distribute measurements to a collection of input adapters.
Inheritance Hierarchy
SystemObject
System.Collections.ObjectModelCollectionIInputAdapter
GSF.CollectionsListCollectionIInputAdapter
GSF.TimeSeries.AdaptersAdapterCollectionBaseIInputAdapter
GSF.TimeSeries.AdaptersInputAdapterCollection
GSF.TimeSeries.AdaptersIndependentInputAdapterManagerBase
System.Collections.ObjectModelCollectionIInputAdapter
GSF.CollectionsListCollectionIInputAdapter
GSF.TimeSeries.AdaptersAdapterCollectionBaseIInputAdapter
GSF.TimeSeries.AdaptersInputAdapterCollection
GSF.TimeSeries.AdaptersIndependentInputAdapterManagerBase
Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.218-beta
Syntaxpublic abstract class IndependentInputAdapterManagerBase : InputAdapterCollection, IIndependentAdapterManager, IAdapterCollection, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IList<IAdapter>, ICollection<IAdapter>, IEnumerable<IAdapter>, IEnumerable
The IndependentInputAdapterManagerBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndependentInputAdapterManagerBase | Creates a new IndependentInputAdapterManagerBase. |
Properties| Name | Description | |
|---|---|---|
 | 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 IndependentInputAdapterManagerBase 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 InputAdapterCollection) |
| Count |
Gets the number of elements contained in the ICollectionT.
(Inherited from ListCollectionT) |
| 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 IndependentInputAdapterManagerBase.
(Overrides AdapterCollectionBaseTDataSource) |
| DescriptionTemplate | Gets or sets template for output measurement descriptions. |
| Enabled |
Gets or sets enabled state of this AdapterCollectionBaseT.
(Inherited from AdapterCollectionBaseT) |
| 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) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any.
(Inherited from AdapterCollectionBaseT) |
| 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 |
Gets or sets the element at the specified index.
(Inherited from ListCollectionT) |
| Items |
Gets a IListT wrapper around the CollectionT.
(Inherited from ListCollectionT) |
| 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 AdapterBase 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. |
| 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) |
| 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 IndependentInputAdapterManagerBase.
(Overrides InputAdapterCollectionStatus) |
| 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| Name | Description | |
|---|---|---|
 | Add |
Adds an item to the ICollectionT.
(Inherited from ListCollectionT) |
| Clear |
Removes all items from the ICollectionT.
(Inherited from ListCollectionT) |
| ClearItems |
Removes all elements from the CollectionT.
(Inherited from AdapterCollectionBaseT) |
| ConfigurationReloaded | Notifies derived classes that configuration has been reloaded |
| Contains |
Determines whether the ICollectionT contains a specific value.
(Inherited from ListCollectionT) |
| CopyTo |
Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ListCollectionT) |
| Dispose |
Releases all the resources used by the AdapterCollectionBaseT object.
(Inherited from AdapterCollectionBaseT) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the IndependentInputAdapterManagerBase object and optionally releases the managed resources.
(Overrides AdapterCollectionBaseTDispose(Boolean)) |
| DisposeItem |
Unwires events and disposes of IInputAdapter implementation.
(Inherited from InputAdapterCollection) |
| EnumerateAdapters | Enumerates child adapters. |
| Equals | Determines 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 ListCollectionT) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetShortStatus |
Gets a short one-line status of this IndependentInputAdapterManagerBase.
(Overrides AdapterCollectionBaseTGetShortStatus(Int32)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IndexOf |
Determines the index of a specific item in the IListT.
(Inherited from ListCollectionT) |
| Initialize |
Initializes the IndependentInputAdapterManagerBase.
(Overrides AdapterCollectionBaseTInitialize) |
| InitializeItem |
Wires events and initializes new IInputAdapter implementation.
(Inherited from InputAdapterCollection) |
| Insert |
Inserts an item to the IListT at the specified index.
(Inherited from ListCollectionT) |
| InsertItem |
Inserts an element into the CollectionT the specified index.
(Inherited from AdapterCollectionBaseT) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBaseT) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBaseT) |
| OnNewMeasurements(ICollectionIMeasurement) |
Raises the NewMeasurements event.
(Inherited from InputAdapterCollection) |
| OnNewMeasurements(Object, EventArgsICollectionIMeasurement) |
Raises the NewMeasurements event.
(Inherited from InputAdapterCollection) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBaseT) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from AdapterCollectionBaseT) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from AdapterCollectionBaseT) |
| OnProcessingComplete |
Raises the ProcessingComplete event.
(Inherited from InputAdapterCollection) |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from AdapterCollectionBaseT) |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterCollectionBaseT) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBaseT) |
| ParseConnectionString | Parses connection string. Derived classes should override for custom connection string parsing. |
| RecalculateRoutingTables | Recalculates routing tables. |
| Remove |
Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from ListCollectionT) |
| RemoveAt |
Removes the element at the specified index of the CollectionT.
(Inherited from ListCollectionT) |
| 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) |
| ToString | Returns 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) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBaseT) |
| 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 input data source.
(Inherited from InputAdapterCollection) |
| 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) |
| ProcessingComplete |
Indicates to the host that processing for one of the input adapters has completed.
(Inherited from InputAdapterCollection) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from AdapterCollectionBaseT) |
Extension Methods| Name | Description | |
|---|---|---|
 | AddRangeIAdapter |
Adds the specified items to the collection.
(Defined by CollectionExtensions) |
| AllParallelIAdapter |
Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel.
(Defined by CollectionExtensions) |
| DistinctByIAdapter, TKey |
Returns only the elements whose keys are distinct.
(Defined by CollectionExtensions) |
| FindAdapter |
Finds child adapter with specified adapterName.
(Defined by IndependentAdapterManagerExtensions) |
| GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
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 IndependentAdapterManagerExtensions) |
| 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) |
| GetRangeIAdapter |
Returns elements in the specified range from the collection.
(Defined by CollectionExtensions) |
| IndexOfIAdapter |
Returns the index of the first element of the sequence that satisfies a condition or -1 if no such element is found.
(Defined by CollectionExtensions) |
| 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) |
| LoadDelimitedStringIAdapter | Appends items parsed from delimited string, created with ToDelimitedString, using the default
delimiter ("|") into the given list. (Defined by CollectionExtensions) |
| LoadDelimitedStringIAdapter | Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions) |
| LoadDelimitedStringIAdapter | Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions) |
| LookupDevice |
Lookups up associated device name from provided signalID.
(Defined by IndependentAdapterManagerExtensions) |
| 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) |
| LookupPhasorLabel |
Lookups up associated phasor label from provided signalID.
(Defined by IndependentAdapterManagerExtensions) |
| LookupPointTag |
Lookups up point tag name from provided signalID.
(Defined by IndependentAdapterManagerExtensions) |
| LookupPointTag |
Looks up point tag name from provided signalID.
(Defined by MetadataHelpers) |
| LookupSignalReference |
Looks up signal reference from provided signalID.
(Defined by MetadataHelpers) |
| MajorityIAdapter |
Returns the majority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions) |
| MajorityIAdapter |
Returns the majority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions) |
| MajorityByIAdapter, TKey |
Returns the majority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions) |
| MajorityByIAdapter, TKey |
Returns the majority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions) |
| MaxIAdapter | Returns the largest item from the enumeration. (Defined by CollectionExtensions) |
| MaxIAdapter | Returns the largest item from the enumeration. (Defined by CollectionExtensions) |
| MaxByIAdapter, TKey | Selects the largest item from the enumeration. (Defined by CollectionExtensions) |
| MedianIAdapter |
Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
(Defined by CollectionExtensions) |
| MiddleIAdapter |
Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
(Defined by CollectionExtensions) |
| MinIAdapter | Returns the smallest item from the enumeration. (Defined by CollectionExtensions) |
| MinIAdapter | Returns the smallest item from the enumeration. (Defined by CollectionExtensions) |
| MinByIAdapter, TKey | Selects the smallest item from the enumeration. (Defined by CollectionExtensions) |
| MinorityIAdapter |
Returns the minority value in the collection, or default type value if no item represents the minority.
(Defined by CollectionExtensions) |
| MinorityIAdapter |
Returns the minority value in the collection, or defaultValue if no item represents the minority.
(Defined by CollectionExtensions) |
| MinorityByIAdapter, TKey |
Returns the minority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions) |
| MinorityByIAdapter, TKey |
Returns the minority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions) |
| OnConfigurationChanged |
Notifies host system of configuration changes.
(Defined by MetadataHelpers) |
| 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) |
| PointTagExists |
Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers) |
| ScrambleIAdapter |
Rearranges all the elements in the list into a highly-random order.
(Defined by CollectionExtensions) |
| ScrambleIAdapter |
Rearranges all the elements in the list into a repeatable pseudo-random order.
(Defined by CollectionExtensions) |
| SignalIDExists |
Determines if signalID exists in local configuration.
(Defined by IndependentAdapterManagerExtensions) |
| SignalIDExists |
Determines if signalID exists in local configuration.
(Defined by MetadataHelpers) |
| SignalReferenceExists |
Determines if signalReference exists in local configuration.
(Defined by MetadataHelpers) |
| StandardDeviationIAdapter |
Computes the standard deviation over a sequence of Double values.
(Defined by NumericalAnalysisExtensions) |
| StandardDeviationIAdapter |
Computes the standard deviation over a sequence of Decimal values.
(Defined by NumericalAnalysisExtensions) |
| StandardDeviationIAdapter |
Computes the standard deviation over a sequence of Single values.
(Defined by NumericalAnalysisExtensions) |
| 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) |
| ToDelimitedStringIAdapter | Converts an enumeration to a string, using the default delimiter ("|") that can later be
converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions) |
| ToDelimitedStringIAdapter | Converts an enumeration to a string that can later be converted back to a list using
LoadDelimitedString. (Defined by CollectionExtensions) |
| ToDelimitedStringIAdapter | Converts an enumeration to a string that can later be converted back to a list using
LoadDelimitedString. (Defined by CollectionExtensions) |
| ToPagedListIAdapter |
Gets a PagedListT to paginate source enumeration for
a given page and specified pageSize.
(Defined by CollectionExtensions) |
| UnscrambleIAdapter |
Rearranges all the elements in the list previously scrambled with ScrambleTSource(IListTSource, Int32) back into their original order.
(Defined by CollectionExtensions) |
| UpdateRangeIAdapter |
Updates collection starting at the index with the specified items.
(Defined by CollectionExtensions) |
| WaitForSignalsToLoad |
Waits for signalIDs to be loaded in system configuration.
(Defined by IndependentAdapterManagerExtensions) |
| WaitForSignalsToLoad |
Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers) |
See Also