Click or drag to resize

IAdapterCollection Interface
Represents the abstract interface for a collection of adapters.

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.258-beta
Syntax
Copy
public interface IAdapterCollection : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus, IList<IAdapter>, 
	ICollection<IAdapter>, IEnumerable<IAdapter>, IEnumerable

The IAdapterCollection type exposes the following members.

Properties
 NameDescription
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or connect on demand.
(Inherited from IAdapter)
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Inherited from IAdapter)
Public propertyConnectionString Gets or sets key/value pair connection information specific to IAdapter.
(Inherited from IAdapter)
Public propertyCountGets the number of elements contained in the ICollectionT.
(Inherited from ICollectionIAdapter)
Public propertyDataMember Gets or sets specific data member (e.g., table name) in DataSource used to initialize this IAdapterCollection.
Public propertyDataSource Gets or sets DataSet based data source available to IAdapter.
(Inherited from IAdapter)
Public propertyEnabled Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle)
Public propertyID Gets or sets the numeric ID associated with this IAdapter.
(Inherited from IAdapter)
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from IAdapter)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from IAdapter)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the adapter expects.
(Inherited from IAdapter)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle)
Public propertyIsReadOnlyGets a value indicating whether the ICollectionT is read-only.
(Inherited from ICollectionIAdapter)
Public propertyItemGets or sets the element at the specified index.
(Inherited from IListIAdapter)
Public propertyName Gets or sets name of this IAdapter.
(Inherited from IAdapter)
Public propertyOutputMeasurements Gets or sets output measurements that the adapter will produce, if any.
(Inherited from IAdapter)
Public propertyProcessedMeasurements Gets the total number of measurements processed thus far by the IAdapter.
(Inherited from IAdapter)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from IAdapter)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from IAdapter)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter)
Public propertyStatus Gets the current status details about object providing status information.
(Inherited from IProvideStatus)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from IAdapter)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Inherited from IAdapter)
Top
Methods
 NameDescription
Public methodAddAdds an item to the ICollectionT.
(Inherited from ICollectionIAdapter)
Public methodClearRemoves all items from the ICollectionT.
(Inherited from ICollectionIAdapter)
Public methodContainsDetermines whether the ICollectionT contains a specific value.
(Inherited from ICollectionIAdapter)
Public methodCopyToCopies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from ICollectionIAdapter)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodGetEnumeratorReturns an enumerator that iterates through the collection.
(Inherited from IEnumerableIAdapter)
Public methodGetShortStatus Gets a short one-line adapter status.
(Inherited from IAdapter)
Public methodIndexOfDetermines the index of a specific item in the IListT.
(Inherited from IListIAdapter)
Public methodInitialize Initializes the state of the object.
(Inherited from ISupportLifecycle)
Public methodInsertInserts an item to the IListT at the specified index.
(Inherited from IListIAdapter)
Public methodRemoveRemoves the first occurrence of a specific object from the ICollectionT.
(Inherited from ICollectionIAdapter)
Public methodRemoveAtRemoves the IListT item at the specified index.
(Inherited from IListIAdapter)
Public methodResetStatistics Resets the statistics of this collection.
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from IAdapter)
Public methodStart Starts the adapter, if it is not already running.
(Inherited from IAdapter)
Public methodStop Stops the adapter.
(Inherited from IAdapter)
Public methodTryCreateAdapter Attempts to create an IAdapter from the specified DataRow.
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.
(Inherited from IAdapter)
Public eventDisposed Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from IAdapter)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from IAdapter)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from IAdapter)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from IAdapter)
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 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