Gemstone Timeseries Library
Show/Hide TOC

# OutputAdapterCollection Class

Represents a collection of IOutputAdapter implementations.

## Definition

Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.138 -- Release Build+b4f8847fe309a44734617722bca179874d85b46d
C#
View Source Request Example

    public class OutputAdapterCollection : AdapterCollectionBase<IOutputAdapter>,
    	IOutputAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

VB
View Source Request Example

    Public Class OutputAdapterCollection
    	Inherits AdapterCollectionBase(Of IOutputAdapter)
    	Implements IOutputAdapter, IAdapter, ISupportLifecycle, IDisposable,
    	IProvideStatus

C++
View Source Request Example

    public ref class OutputAdapterCollection : public AdapterCollectionBase<IOutputAdapter^>,
    	IOutputAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus

JavaScript
View Source Request Example

    Gemstone.Timeseries.Adapters.OutputAdapterCollection = function();

    Type.createClass(
    	'Gemstone.Timeseries.Adapters.OutputAdapterCollection',
    	Gemstone.Timeseries.Adapters.AdapterCollectionBase`1,
    	Gemstone.Timeseries.Adapters.IOutputAdapter,
    	Gemstone.Timeseries.Adapters.IAdapter,
    	ISupportLifecycle,
    	IDisposable,
    	IProvideStatus);

Inheritance
  Object Collection IOutputAdapter ListCollection IOutputAdapter AdapterCollectionBase IOutputAdapter OutputAdapterCollection

Derived
  Gemstone.Timeseries.AdaptersIndependentOutputAdapterManagerBase

Implements
  IProvideStatus, ISupportLifecycle, IAdapter, IOutputAdapter, IDisposable

## Constructors

OutputAdapterCollection | Creates a new OutputAdapterCollection.

## Properties

AutoInitialize | Gets flag that determines if IAdapter implementations are automatically initialized when they are added to the collection. (Inherited from AdapterCollectionBaseT)
AutoStart | Gets or sets flag indicating if adapter collection should automatically start items when AutoInitialize is false. (Inherited from AdapterCollectionBaseT)
ConnectionString | Gets or sets key/value pair connection information specific to this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
Count | Gets the number of elements contained in the ICollectionT. (Inherited from ListCollection IOutputAdapter)
DataMember | Gets or sets specific data member (e.g., table name) in DataSource used to Initialize this AdapterCollectionBaseT. (Inherited from 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. (Inherited from AdapterCollectionBaseT)
Enabled | Gets or sets enabled state of this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
ID | Gets or sets numeric ID associated with this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
InitializationTimeout | Gets or sets the default adapter time that represents the maximum time system will wait during Start for initialization. (Inherited from AdapterCollectionBaseT)
Initialized | Gets or sets flag indicating if the adapter collection has been initialized successfully. (Inherited from AdapterCollectionBaseT)
InputMeasurementKeys | Gets or sets primary keys of input measurements the AdapterCollectionBaseT expects, if any. (Inherited from AdapterCollectionBaseT)
InputSourceIDs | Gets or sets Source values used to filter input measurement keys. (Inherited from AdapterCollectionBaseT)
IsDisposed | Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterCollectionBaseT)
IsReadOnly | Gets a value indicating whether the AdapterCollectionBaseT is read-only. (Inherited from AdapterCollectionBaseT)
Item(Int32) | Gets or sets the element at the specified index. (Inherited from ListCollection IOutputAdapter)
Items | Gets a IListT wrapper around the CollectionT. (Inherited from ListCollection IOutputAdapter)
Log | Log messages generated by an adapter. (Inherited from AdapterCollectionBaseT)
MonitorTimerEnabled | Gets or sets flag that determines if monitor timer should be used for monitoring processed measurement statistics for the AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
Name | Gets or sets the name of this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
OutputIsForArchive | Returns a flag that determines if all measurements sent to this OutputAdapterCollection are destined for archival.
OutputMeasurements | Gets or sets output measurements that the AdapterCollectionBaseT will produce, if any. (Inherited from AdapterCollectionBaseT)
OutputSourceIDs | Gets or sets Source values used to filter output measurements. (Inherited from AdapterCollectionBaseT)
ProcessedMeasurements | Gets the total number of measurements processed and destined for archive thus far by each IOutputAdapter implementation in the OutputAdapterCollection. (Overrides AdapterCollectionBaseT ProcessedMeasurements)
ProcessingInterval | Gets or sets the desired processing interval, in milliseconds, for the adapter collection and applies this interval to each adapter. (Inherited from AdapterCollectionBaseT)
RequestedInputMeasurementKeys | Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from AdapterCollectionBaseT)
RequestedOutputMeasurementKeys | Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from AdapterCollectionBaseT)
RunTime | Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterCollectionBaseT)
Settings | Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterCollectionBaseT)
StartTime | Gets the UTC time this AdapterCollectionBaseT was started. (Inherited from AdapterCollectionBaseT)
StartTimeConstraint | Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterCollectionBaseT)
Status | Gets the descriptive status of this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
StopTime | Gets the UTC time this AdapterCollectionBaseT was stopped. (Inherited from AdapterCollectionBaseT)
StopTimeConstraint | Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterCollectionBaseT)
SupportsTemporalProcessing | Gets the flag indicating if this adapter collection supports temporal processing. (Inherited from AdapterCollectionBaseT)

## Methods

Add(T1) | Adds an item to the ICollectionT. (Inherited from ListCollection IOutputAdapter)
Clear | Removes all items from the ICollectionT. (Inherited from ListCollection IOutputAdapter)
ClearItems | Removes all elements from the CollectionT. (Inherited from AdapterCollectionBaseT)
Contains(T1) | Determines whether the ICollectionT contains a specific value. (Inherited from ListCollection IOutputAdapter)
CopyTo(T1[], Int32) | Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from ListCollection IOutputAdapter)
Dispose | Releases all the resources used by the AdapterCollectionBaseT object. (Inherited from AdapterCollectionBaseT)
Dispose(Boolean) | Releases the unmanaged resources used by the AdapterCollectionBaseT object and optionally releases the managed resources. (Inherited from AdapterCollectionBaseT)
DisposeItem | Unwires events and disposes of IOutputAdapter implementation. (Overrides AdapterCollectionBaseT DisposeItem(T))
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. (Inherited from AdapterCollectionBaseT)
GetEnumerator | Returns an enumerator that iterates through the CollectionT. (Inherited from ListCollection IOutputAdapter)
GetHashCode | Serves as the default hash function. (Inherited from Object)
GetShortStatus | Gets a short one-line status of this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
GetType | Gets the Type of the current instance. (Inherited from Object)
IndexOf(T1) | Determines the index of a specific item in the IListT. (Inherited from ListCollection IOutputAdapter)
Initialize | Loads all IAdapter implementations defined in DataSource. (Inherited from AdapterCollectionBaseT)
InitializeItem | Wires events and initializes new IOutputAdapter implementation. (Overrides AdapterCollectionBaseT InitializeItem(T))
Insert(Int32, T1) | Inserts an item to the IListT at the specified index. (Inherited from ListCollection IOutputAdapter)
InsertItem | Inserts an element into the CollectionT the specified index. (Inherited from AdapterCollectionBaseT)
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object)
OnConfigurationChanged | Raises ConfigurationChanged event. (Inherited from AdapterCollectionBaseT)
OnInputMeasurementKeysUpdated | Raises InputMeasurementKeysUpdated event. (Inherited from AdapterCollectionBaseT)
OnOutputMeasurementsUpdated | Raises OutputMeasurementsUpdated event. (Inherited from AdapterCollectionBaseT)
OnProcessException | Raises the ProcessException event. (Inherited from AdapterCollectionBaseT)
OnStatusMessage | Raises the StatusMessage event and sends this data to the Logger. (Inherited from AdapterCollectionBaseT)
OnUnprocessedMeasurements | Raises the UnprocessedMeasurements event.
QueueMeasurementsForProcessing | Queues a collection of measurements for processing to each IOutputAdapter implementation in this OutputAdapterCollection.
Remove(T1) | Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ListCollection IOutputAdapter)
RemoveAt(Int32) | Removes the element at the specified index of the CollectionT. (Inherited from ListCollection IOutputAdapter)
RemoveItem | Removes the element at the specified index of the CollectionT. (Inherited from AdapterCollectionBaseT)
RemoveMeasurements | This function removes a range of measurements from the internal measurement queues. Note that the requested total will be removed from each IOutputAdapter implementation in this OutputAdapterCollection.
ResetStatistics | Resets the statistics of this collection. (Inherited from AdapterCollectionBaseT)
SetItem | Assigns a new element to the CollectionT at the specified index. (Inherited from AdapterCollectionBaseT)
SetTemporalConstraint | Defines a temporal processing constraint for the adapter collection and applies this constraint to each adapter. (Inherited from AdapterCollectionBaseT)
Start | Starts, or restarts, each IAdapter implementation in this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
Stop | Stops each IAdapter implementation in this AdapterCollectionBaseT. (Inherited from AdapterCollectionBaseT)
ToString | Returns a string that represents the current object. (Inherited from Object)
TryCreateAdapter | Attempts to create an IAdapter from the specified DataRow. (Inherited from AdapterCollectionBaseT)
TryGetAdapterTValue | Attempts to get the adapter with the specified value given testItem function. (Inherited from AdapterCollectionBaseT)
TryGetAdapterByID | Attempts to get the adapter with the specified id. (Inherited from AdapterCollectionBaseT)
TryGetAdapterByName | Attempts to get the adapter with the specified name. (Inherited from AdapterCollectionBaseT)
TryInitializeAdapterByID | Attempts to initialize (or reinitialize) an individual IAdapter based on its ID. (Inherited from AdapterCollectionBaseT)

## Events

ConfigurationChanged | Event is raised when adapter is aware of a configuration change. (Inherited from AdapterCollectionBaseT)
Disposed | Event is raised when this AdapterCollectionBaseT is disposed or an IAdapter in the collection is disposed. (Inherited from AdapterCollectionBaseT)
InputMeasurementKeysUpdated | Event is raised when InputMeasurementKeys are updated. (Inherited from AdapterCollectionBaseT)
OutputMeasurementsUpdated | Event is raised when OutputMeasurements are updated. (Inherited from AdapterCollectionBaseT)
ProcessException | Event is raised when there is an exception encountered while processing. (Inherited from AdapterCollectionBaseT)
StatusMessage | Provides status messages to consumer. (Inherited from AdapterCollectionBaseT)
UnprocessedMeasurements | Event is raised every five seconds allowing host to track total number of unprocessed measurements.

## Extension Methods

InputMeasurementKeys | Returns the MeasurementKey values of the IAdapter input measurements. (Defined by IAdapterExtensions)
OutputMeasurementKeys | Returns the MeasurementKey values of the IAdapter output measurements. (Defined by IAdapterExtensions)
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)

## See Also

#### Reference

Gemstone.Timeseries.Adapters Namespace