|
IAdapter
|
Represents the abstract interface for a collection of adapters.
Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.207-beta
Syntaxpublic interface IAdapterCollection : IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IList<IAdapter>, ICollection<IAdapter>, IEnumerable<IAdapter>, IEnumerable
The IAdapterCollection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AutoStart |
Gets or sets flag indicating if adapter should automatically start or connect on demand.
(Inherited from IAdapter) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from IAdapter) |
| ConnectionString |
Gets or sets key/value pair connection information specific to IAdapter.
(Inherited from IAdapter) |
| Count | Gets the number of elements contained in the ICollectionT. (Inherited from ICollectionIAdapter) |
| DataMember | Gets or sets specific data member (e.g., table name) in DataSource used to initialize this IAdapterCollection. |
| DataSource |
Gets or sets DataSet based data source available to IAdapter.
(Inherited from IAdapter) |
| Enabled |
Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle) |
| ID |
Gets or sets the numeric ID associated with this IAdapter.
(Inherited from IAdapter) |
| InitializationTimeout |
Gets or sets maximum time system will wait during Start for initialization.
(Inherited from IAdapter) |
| Initialized |
Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from IAdapter) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the adapter expects.
(Inherited from IAdapter) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle) |
| IsReadOnly | Gets a value indicating whether the ICollectionT is read-only. (Inherited from ICollectionIAdapter) |
| Item | Gets or sets the element at the specified index. (Inherited from IListIAdapter) |
| Name |
Gets or sets name of this IAdapter.
(Inherited from IAdapter) |
| OutputMeasurements |
Gets or sets output measurements that the adapter will produce, if any.
(Inherited from IAdapter) |
| ProcessedMeasurements |
Gets the total number of measurements processed thus far by the IAdapter.
(Inherited from IAdapter) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from IAdapter) |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from IAdapter) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter) |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter) |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter supports temporal processing.
(Inherited from IAdapter) |
Methods| Name | Description | |
|---|---|---|
 | Add | Adds an item to the ICollectionT. (Inherited from ICollectionIAdapter) |
| Clear | Removes all items from the ICollectionT. (Inherited from ICollectionIAdapter) |
| Contains | Determines whether the ICollectionT contains a specific value. (Inherited from ICollectionIAdapter) |
| CopyTo | Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from ICollectionIAdapter) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| GetEnumerator | Returns an enumerator that iterates through the collection. (Inherited from IEnumerableIAdapter) |
| GetShortStatus |
Gets a short one-line adapter status.
(Inherited from IAdapter) |
| IndexOf | Determines the index of a specific item in the IListT. (Inherited from IListIAdapter) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| Insert | Inserts an item to the IListT at the specified index. (Inherited from IListIAdapter) |
| Remove | Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ICollectionIAdapter) |
| RemoveAt | Removes the IListT item at the specified index. (Inherited from IListIAdapter) |
| ResetStatistics | Resets the statistics of this collection. |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter.
(Inherited from IAdapter) |
| Start |
Starts the adapter, if it is not already running.
(Inherited from IAdapter) |
| Stop |
Stops the adapter.
(Inherited from IAdapter) |
| TryCreateAdapter | Attempts to create an IAdapter from the specified DataRow. |
| TryGetAdapterByID | Attempts to get the adapter with the specified id. |
| TryGetAdapterByName | Attempts to get the adapter with the specified name. |
| TryInitializeAdapterByID | Attempts to initialize (or reinitialize) an individual IAdapter based on its ID. |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from IAdapter) |
| Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from IAdapter) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from IAdapter) |
| ProcessException |
Event is raised when there is an exception encountered while processing.
(Inherited from IAdapter) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from IAdapter) |
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) |
| 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 |
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) |
| 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 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 MetadataHelpers) |
See Also