Click or drag to resize

AdapterCollectionBaseT Class
Represents a collection of IAdapter implementations.
Inheritance Hierarchy
SystemObject
  System.Collections.ObjectModelCollectionT
    GSF.CollectionsListCollectionT
      GSF.TimeSeries.AdaptersAdapterCollectionBaseT
        More

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

Type Parameters

T
Type of IAdapter this collection contains.

The AdapterCollectionBaseT type exposes the following members.

Constructors
 NameDescription
Protected methodAdapterCollectionBaseT Constructs a new instance of the AdapterCollectionBaseT.
Top
Properties
 NameDescription
Protected propertyAutoInitialize Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection.
Public propertyAutoStart Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false.
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT.
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.
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.
Public propertyEnabled Gets or sets enabled state of this AdapterCollectionBaseT.
Public propertyID Gets or sets numeric ID associated with this AdapterCollectionBaseT.
Public propertyInitializationTimeout Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization.
Public propertyInitialized Gets or sets flag indicating if the adapter collection has been initialized successfully.
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any.
Public propertyInputSourceIDs Gets or sets Source values used to filter input measurement keys.
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
Public propertyIsReadOnly Gets a value indicating whether the AdapterCollectionBaseT is read-only.
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.
Protected propertyMonitorTimerEnabled Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT.
Public propertyName Gets or sets the name of this AdapterCollectionBaseT.
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterCollectionBaseT will produce, if any.
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
Public propertyProcessedMeasurements Gets the total number of measurements processed thus far by each IAdapter implementation in the AdapterCollectionBaseT.
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter.
Public propertyRequestedInputMeasurementKeys Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
Public propertyStartTime Gets the UTC time this AdapterCollectionBaseT was started.
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
Public propertyStatus Gets the descriptive status of this AdapterCollectionBaseT.
Public propertyStopTime Gets the UTC time this AdapterCollectionBaseT was stopped.
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter collection supports temporal processing.
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.
(Overrides ListCollectionTClearItems)
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.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the AdapterCollectionBaseT object and optionally releases the managed resources.
Protected methodDisposeItem Un-wires events and disposes of IAdapter implementation.
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.
(Overrides ObjectFinalize)
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.
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 Loads all IAdapter implementations defined in DataSource.
Protected methodInitializeItem Wires events and initializes new IAdapter implementation.
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.
(Overrides ListCollectionTInsertItem(Int32, T))
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
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.
(Overrides ListCollectionTRemoveItem(Int32))
Public methodResetStatistics Resets the statistics of this collection.
Protected methodSetItem Assigns a new element to the CollectionT at the specified index.
(Overrides ListCollectionTSetItem(Int32, T))
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter.
Public methodStart Starts, or restarts, each IAdapter implementation in this AdapterCollectionBaseT.
Public methodStop Stops each IAdapter implementation in this AdapterCollectionBaseT.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryCreateAdapter Attempts to create an IAdapter from the specified DataRow.
Protected methodTryGetAdapterTValue Attempts to get the adapter with the specified value given testItem function.
Public methodTryGetAdapterByID Attempts to get the adapter with the specified id.
Public methodTryGetAdapterByName Attempts to get the adapter with the specified name.
Public methodTryInitializeAdapterByID Attempts to initialize (or reinitialize) an individual IAdapter based on its ID.
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
Public eventDisposed Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed.
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
Public eventProcessException Event is raised when there is an exception encountered while processing.
Public eventStatusMessage Provides status messages to consumer.
Top
Extension Methods
 NameDescription
Public Extension MethodAddRangeIAdapter Adds the specified items to the collection.
(Defined by CollectionExtensions)
Public Extension MethodAllParallelIAdapter Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel.
(Defined by CollectionExtensions)
Public Extension MethodDistinctByIAdapter, TKey Returns only the elements whose keys are distinct.
(Defined by CollectionExtensions)
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 MethodGetRangeIAdapter Returns elements in the specified range from the collection.
(Defined by CollectionExtensions)
Public Extension MethodIndexOfIAdapter 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)
Public Extension MethodInputMeasurementKeys Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions)
Public Extension MethodInputMeasurementKeysIAdapter Gets a distinct list of input measurement keys for all of the provided adapters.
(Defined by IAdapterExtensions)
Public Extension MethodLoadDelimitedStringIAdapterAppends items parsed from delimited string, created with ToDelimitedString, using the default delimiter ("|") into the given list.
(Defined by CollectionExtensions)
Public Extension MethodLoadDelimitedStringIAdapterAppends items parsed from delimited string, created with ToDelimitedString, into the given list.
(Defined by CollectionExtensions)
Public Extension MethodLoadDelimitedStringIAdapterAppends items parsed from delimited string, created with ToDelimitedString, into the given list.
(Defined by CollectionExtensions)
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 MethodMajorityIAdapter Returns the majority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions)
Public Extension MethodMajorityIAdapter Returns the majority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions)
Public Extension MethodMajorityByIAdapter, TKey Returns the majority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions)
Public Extension MethodMajorityByIAdapter, TKey Returns the majority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions)
Public Extension MethodMaxIAdapterReturns the largest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMaxIAdapterReturns the largest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMaxByIAdapter, TKeySelects the largest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMedianIAdapter Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
(Defined by CollectionExtensions)
Public Extension MethodMiddleIAdapter Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths.
(Defined by CollectionExtensions)
Public Extension MethodMinIAdapterReturns the smallest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMinIAdapterReturns the smallest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMinByIAdapter, TKeySelects the smallest item from the enumeration.
(Defined by CollectionExtensions)
Public Extension MethodMinorityIAdapter Returns the minority value in the collection, or default type value if no item represents the minority.
(Defined by CollectionExtensions)
Public Extension MethodMinorityIAdapter Returns the minority value in the collection, or defaultValue if no item represents the minority.
(Defined by CollectionExtensions)
Public Extension MethodMinorityByIAdapter, TKey Returns the minority value in the collection, or default type value if no item represents the majority.
(Defined by CollectionExtensions)
Public Extension MethodMinorityByIAdapter, TKey Returns the minority value in the collection, or defaultValue if no item represents the majority.
(Defined by CollectionExtensions)
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 MethodOutputMeasurementKeysIAdapter Gets a distinct list of output measurement keys for all of the provided adapters.
(Defined by IAdapterExtensions)
Public Extension MethodPointTagExists Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers)
Public Extension MethodScrambleIAdapter Rearranges all the elements in the list into a highly-random order.
(Defined by CollectionExtensions)
Public Extension MethodScrambleIAdapter Rearranges all the elements in the list into a repeatable pseudo-random order.
(Defined by CollectionExtensions)
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 MethodStandardDeviationIAdapter Computes the standard deviation over a sequence of Double values.
(Defined by NumericalAnalysisExtensions)
Public Extension MethodStandardDeviationIAdapter Computes the standard deviation over a sequence of Decimal values.
(Defined by NumericalAnalysisExtensions)
Public Extension MethodStandardDeviationIAdapter Computes the standard deviation over a sequence of Single values.
(Defined by NumericalAnalysisExtensions)
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 MethodToDelimitedStringIAdapterConverts an enumeration to a string, using the default delimiter ("|") that can later be converted back to a list using LoadDelimitedString.
(Defined by CollectionExtensions)
Public Extension MethodToDelimitedStringIAdapterConverts an enumeration to a string that can later be converted back to a list using LoadDelimitedString.
(Defined by CollectionExtensions)
Public Extension MethodToDelimitedStringIAdapterConverts an enumeration to a string that can later be converted back to a list using LoadDelimitedString.
(Defined by CollectionExtensions)
Public Extension MethodToPagedListIAdapter Gets a PagedListT to paginate source enumeration for a given page and specified pageSize.
(Defined by CollectionExtensions)
Public Extension MethodUnscrambleIAdapter Rearranges all the elements in the list previously scrambled with ScrambleTSource(IListTSource, Int32) back into their original order.
(Defined by CollectionExtensions)
Public Extension MethodUpdateRangeIAdapter Updates collection starting at the index with the specified items.
(Defined by CollectionExtensions)
Public Extension MethodWaitForSignalsToLoad Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers)
Top
See Also
Inheritance Hierarchy