Click or drag to resize

AllAdaptersCollection Class

Represents a collection of all IAdapterCollection implementations (i.e., a collection of IAdapterCollection's).
Inheritance Hierarchy

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.242-beta
Syntax
public class AllAdaptersCollection : AdapterCollectionBase<IAdapterCollection>
View Source

The AllAdaptersCollection type exposes the following members.

Constructors
 NameDescription
Public methodAllAdaptersCollection Constructs a new instance of the AllAdaptersCollection.
Top
Properties
 NameDescription
Protected propertyAutoInitialize Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection.
(Overrides AdapterCollectionBase<T>.AutoInitialize)
Public propertyAutoStart Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
(Inherited from AdapterCollectionBase<T>)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyCount Gets the number of elements contained in the ICollection<T>.
(Inherited from ListCollection<T>)
Public propertyDataMember Gets or sets specific data member (e.g., table name) in DataSource used to Initialize() this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
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 AdapterCollectionBase<T>.
(Overrides AdapterCollectionBase<T>.DataSource)
Public propertyEnabled Gets or sets enabled state of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyID Gets or sets numeric ID associated with this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyInitializationTimeout Gets or sets the default adapter time that represents the maximum time system will wait during Start() for initialization.
(Inherited from AdapterCollectionBase<T>)
Public propertyInitialized Gets or sets flag indicating if the adapter collection has been initialized successfully.
(Inherited from AdapterCollectionBase<T>)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterCollectionBase<T> expects, if any.
(Inherited from AdapterCollectionBase<T>)
Public propertyInputSourceIDs Gets or sets Source values used to filter input measurement keys.
(Inherited from AdapterCollectionBase<T>)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterCollectionBase<T>)
Public propertyIsReadOnly Gets a value indicating whether the AdapterCollectionBase<T> is read-only.
(Inherited from AdapterCollectionBase<T>)
Public propertyItem Gets or sets the element at the specified index.
(Inherited from ListCollection<T>)
Protected propertyItems Gets a IList<T> wrapper around the Collection<T>.
(Inherited from ListCollection<T>)
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterCollectionBase<T>)
Protected propertyMonitorTimerEnabled 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>)
Public propertyName Gets or sets the name of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterCollectionBase<T> will produce, if any.
(Inherited from AdapterCollectionBase<T>)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from AdapterCollectionBase<T>)
Public propertyProcessedMeasurements Gets the total number of measurements processed thus far by each IAdapter implementation in the AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
(Inherited from AdapterCollectionBase<T>)
Public propertyRequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBase<T>)
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from AdapterCollectionBase<T>)
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterCollectionBase<T>)
Public propertySettings Gets settings Dictionary<TKey, TValue> parsed when ConnectionString was assigned.
(Inherited from AdapterCollectionBase<T>)
Public propertyStartTime Gets the UTC time this AdapterCollectionBase<T> was started.
(Inherited from AdapterCollectionBase<T>)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBase<T>)
Public propertyStatus Gets the descriptive status of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public propertyStopTime Gets the UTC time this AdapterCollectionBase<T> was stopped.
(Inherited from AdapterCollectionBase<T>)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterCollectionBase<T>)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter collection supports temporal processing.
(Inherited from AdapterCollectionBase<T>)
Top
Methods
 NameDescription
Public methodAdd Adds an item to the ICollection<T>.
(Inherited from ListCollection<T>)
Public methodClear Removes all items from the ICollection<T>.
(Inherited from ListCollection<T>)
Protected methodClearItems Removes all elements from the Collection<T>.
(Inherited from AdapterCollectionBase<T>)
Public methodContains Determines whether the ICollection<T> contains a specific value.
(Inherited from ListCollection<T>)
Public methodCopyTo Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
(Inherited from ListCollection<T>)
Public methodDispose() Releases all the resources used by the AdapterCollectionBase<T> object.
(Inherited from AdapterCollectionBase<T>)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the AdapterCollectionBase<T> object and optionally releases the managed resources.
(Inherited from AdapterCollectionBase<T>)
Protected methodDisposeItem Un-wires events and disposes of IAdapter implementation.
(Inherited from AdapterCollectionBase<T>)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the AdapterCollectionBase<T> object is reclaimed by GC.
(Inherited from AdapterCollectionBase<T>)
Public methodGetEnumerator Returns an enumerator that iterates through the Collection<T>.
(Inherited from ListCollection<T>)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetShortStatus Gets a short one-line status of this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Determines the index of a specific item in the IList<T>.
(Inherited from ListCollection<T>)
Public methodInitialize Initializes each IAdapterCollection implementation in this AllAdaptersCollection.
(Overrides AdapterCollectionBase<T>.Initialize())
Protected methodInitializeItem Wires events and initializes new IAdapter implementation.
(Overrides AdapterCollectionBase<T>.InitializeItem(T))
Public methodInsert Inserts an item to the IList<T> at the specified index.
(Inherited from ListCollection<T>)
Protected methodInsertItem Inserts an element into the Collection<T> the specified index.
(Inherited from AdapterCollectionBase<T>)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnStatusMessage(String, Object[])Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterCollectionBase<T>)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterCollectionBase<T>)
Public methodRemove Removes the first occurrence of a specific object from the ICollection<T>.
(Inherited from ListCollection<T>)
Public methodRemoveAt Removes the element at the specified index of the Collection<T>.
(Inherited from ListCollection<T>)
Protected methodRemoveItem Removes the element at the specified index of the Collection<T>.
(Inherited from AdapterCollectionBase<T>)
Public methodResetStatistics Resets the statistics of this collection.
(Inherited from AdapterCollectionBase<T>)
Protected methodSetItem Assigns a new element to the Collection<T> at the specified index.
(Inherited from AdapterCollectionBase<T>)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
(Inherited from AdapterCollectionBase<T>)
Public methodStart Starts, or restarts, each IAdapter implementation in this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public methodStop Stops each IAdapter implementation in this AdapterCollectionBase<T>.
(Inherited from AdapterCollectionBase<T>)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryCreateAdapter This method is not implemented in AllAdaptersCollection.
(Overrides AdapterCollectionBase<T>.TryCreateAdapter(DataRow, T))
Protected methodTryGetAdapter<TValue> Attempts to get the adapter with the specified value given testItem function.
(Inherited from AdapterCollectionBase<T>)
Public methodTryGetAdapterByID This method is not implemented in AllAdaptersCollection.
(Overrides AdapterCollectionBase<T>.TryGetAdapterByID(UInt32, T))
Public methodTryGetAdapterByName Attempts to get the adapter with the specified name.
(Inherited from AdapterCollectionBase<T>)
Public methodTryGetAnyAdapterByID Attempts to get any adapter in all collections with the specified id.
Public methodTryGetAnyAdapterByName Attempts to get any adapter in all collections with the specified name.
Public methodTryInitializeAdapterByID Attempts to initialize (or reinitialize) an individual IAdapter based on its ID from any collection.
(Overrides AdapterCollectionBase<T>.TryInitializeAdapterByID(UInt32))
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterCollectionBase<T>)
Public eventDisposed Event is raised when this AdapterCollectionBase<T> is disposed or an IAdapter in the collection is disposed.
(Inherited from AdapterCollectionBase<T>)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterCollectionBase<T>)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterCollectionBase<T>)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterCollectionBase<T>)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterCollectionBase<T>)
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 MethodGetEnumValueOrDefault<T> Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
Remarks
This collection allows all IAdapterCollection implementations to be managed as a group.
See Also