|
|
Adapter
|
[EditorBrowsableAttribute(EditorBrowsableState.Never)] public abstract class AdapterCollectionBase<T> : ListCollection<T>, IAdapterCollection, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IList<IAdapter>, ICollection<IAdapter>, IEnumerable<IAdapter>, IEnumerable where T : class, IAdapter
The AdapterCollectionBaseT type exposes the following members.
| Name | Description | |
|---|---|---|
| AdapterCollectionBaseT | Constructs a new instance of the AdapterCollectionBaseT. |
| Name | Description | |
|---|---|---|
| AutoInitialize | Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection. | |
| AutoStart | Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false. | |
| ConnectionString | Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT. | |
| Count |
Gets the number of elements contained in the ICollectionT.
(Inherited from ListCollectionT) | |
| DataMember | Gets or sets specific data member (e.g., table name) in DataSource used to Initialize this AdapterCollectionBaseT. | |
| DataSource | Gets or sets DataSet based data source used to load each IAdapter. Updates to this property will cascade to all items in this AdapterCollectionBaseT. | |
| Enabled | Gets or sets enabled state of this AdapterCollectionBaseT. | |
| ID | Gets or sets numeric ID associated with this AdapterCollectionBaseT. | |
| InitializationTimeout | Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization. | |
| Initialized | Gets or sets flag indicating if the adapter collection has been initialized successfully. | |
| InputMeasurementKeys | Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any. | |
| InputSourceIDs | Gets or sets Source values used to filter input measurement keys. | |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. | |
| IsReadOnly | Gets a value indicating whether the AdapterCollectionBaseT is read-only. | |
| 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. | |
| MonitorTimerEnabled | Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT. | |
| Name | Gets or sets the name of this AdapterCollectionBaseT. | |
| OutputMeasurements | Gets or sets output measurements that the AdapterCollectionBaseT will produce, if any. | |
| OutputSourceIDs | Gets or sets Source values used to filter output measurements. | |
| ProcessedMeasurements | Gets the total number of measurements processed thus far by each IAdapter implementation in the AdapterCollectionBaseT. | |
| ProcessingInterval | Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter. | |
| RequestedInputMeasurementKeys | Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. | |
| RequestedOutputMeasurementKeys | Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide. | |
| RunTime | Gets the total amount of time, in seconds, that the adapter has been active. | |
| Settings | Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. | |
| StartTime | Gets the UTC time this AdapterCollectionBaseT was started. | |
| StartTimeConstraint | Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). | |
| Status | Gets the descriptive status of this AdapterCollectionBaseT. | |
| StopTime | Gets the UTC time this AdapterCollectionBaseT was stopped. | |
| StopTimeConstraint | Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). | |
| SupportsTemporalProcessing | Gets the flag indicating if this adapter collection supports temporal processing. |
| 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.
(Overrides ListCollectionTClearItems) | |
| 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. | |
| Dispose(Boolean) | Releases the unmanaged resources used by the AdapterCollectionBaseT object and optionally releases the managed resources. | |
| DisposeItem | Un-wires events and disposes of IAdapter implementation. | |
| 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.
(Overrides ObjectFinalize) | |
| 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 AdapterCollectionBaseT. | |
| 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 | Loads all IAdapter implementations defined in DataSource. | |
| InitializeItem | Wires events and initializes new IAdapter implementation. | |
| Insert |
Inserts an item to the IListT at the specified index.
(Inherited from ListCollectionT) | |
| InsertItem |
Inserts an element into the CollectionT the specified index.
(Overrides ListCollectionTInsertItem(Int32, T)) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnConfigurationChanged | Raises ConfigurationChanged event. | |
| OnInputMeasurementKeysUpdated | Raises InputMeasurementKeysUpdated event. | |
| OnOutputMeasurementsUpdated | Raises OutputMeasurementsUpdated event. | |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. | |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) | Raises the ProcessException event. | |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. | |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. | |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) | Raises the StatusMessage event and sends this data to the Logger. | |
| 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.
(Overrides ListCollectionTRemoveItem(Int32)) | |
| ResetStatistics | Resets the statistics of this collection. | |
| SetItem |
Assigns a new element to the CollectionT at the specified index.
(Overrides ListCollectionTSetItem(Int32, T)) | |
| SetTemporalConstraint | Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter. | |
| Start | Starts, or restarts, each IAdapter implementation in this AdapterCollectionBaseT. | |
| Stop | Stops each IAdapter implementation in this AdapterCollectionBaseT. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) | |
| TryCreateAdapter | Attempts to create an IAdapter from the specified DataRow. | |
| TryGetAdapterTValue | Attempts to get the adapter with the specified value given testItem function. | |
| 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. |
| Name | Description | |
|---|---|---|
| ConfigurationChanged | Event is raised when adapter is aware of a configuration change. | |
| Disposed | Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed. | |
| InputMeasurementKeysUpdated | Event is raised when InputMeasurementKeys are updated. | |
| OutputMeasurementsUpdated | Event is raised when OutputMeasurements are updated. | |
| ProcessException | Event is raised when there is an exception encountered while processing. | |
| StatusMessage | Provides status messages to consumer. |
| 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) | |
| 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 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) |