OutputAdapter Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersOutputAdapterBase
      eDNAAdaptersOutputAdapter

public class OutputAdapter : OutputAdapterBase

Public Class OutputAdapter
	Inherits OutputAdapterBase

public ref class OutputAdapter : public OutputAdapterBase

type OutputAdapter = 
    class
        inherit OutputAdapterBase
    end

eDNAAdapters.OutputAdapter = function();

Type.createClass(
	'eDNAAdapters.OutputAdapter',
	GSF.TimeSeries.Adapters.OutputAdapterBase);

View Source

	Name	Description
	OutputAdapter	Creates a new OutputAdapter

Top

	Name	Description
	AcknowledgeDataPackets	Gets or sets flag that determines if eDNA client API should acknowledge all process errors or protocol errors.
	AutoCreateTags	Gets or sets whether or not this adapter should automatically manage meta-data for eDNA points.
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	AutoUpdateTags	Gets or sets whether or not this adapter should automatically manage meta-data for eDNA points.
	ClearCacheOnStartup	Gets or sets flag that determines if eDNA client API cache should be cleared on startup.
	ConnectionAttemptInterval	Gets or sets the connection attempt interval, in milliseconds, for the data output adapter. (Inherited from OutputAdapterBase)
	ConnectionInfo	Gets connection info for adapter, if any. (Inherited from AdapterBase)
	ConnectionMonitoringInterval	Gets or sets the interval, in milliseconds, to monitor eDNA connection. A zero value will disable the monitor.
	ConnectionString	Gets or sets key/value pair connection information specific to this AdapterBase. (Inherited from AdapterBase)
	DataSource	Gets or sets DataSet based data source available to this OutputAdapterBase. (Inherited from OutputAdapterBase)
	DigitalClearedString	Gets or sets the default string to represent the digital cleared state.
	DigitalSetString	Gets or sets the default string to represent the digital set state.
	EnableCaching	Gets or sets flag that determines if eDNA client API should enable use of a local file system cache.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	EnableQueuing	Gets or sets flag that determines if eDNA client API should enable its memory queue.
	ExpandDigitalWordBits	Gets or sets flag that determines if each bit of digital words are expanded to individual points. Set to False to treat words as analog values.
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization. (Inherited from AdapterBase)
	Initialized	Gets or sets flag indicating if the adapter has been initialized successfully. (Inherited from AdapterBase)
	InputMeasurementKeys	Gets or sets primary keys of input measurements the AdapterBase expects, if any. (Inherited from AdapterBase)
	InputSourceIDs	Gets or sets Source values used to filter input measurements. (Inherited from OutputAdapterBase)
	InternalProcessQueue	Allows derived class access to internal processing queue. (Inherited from OutputAdapterBase)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterBase)
	LocalCacheFileName	Gets or sets the filename to be used for point map cache.
	Log	Log messages generated by an adapter. (Inherited from AdapterBase)
	MaximumPointResolution	Gets or sets the maximum time resolution, in seconds, for data points being archived, e.g., a value 1.0 would mean that data would be archived no more than once per second. A zero value indicates that all data should be archived.
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	MetadataRefreshOperation	Gets the operation that calls ExecuteMetadataRefresh. (Inherited from OutputAdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputIsForArchive	Returns true to indicate that this OutputAdapter is sending measurements to a historian, i.e., eDNA. (Overrides OutputAdapterBaseOutputIsForArchive)
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from OutputAdapterBase)
	PointMapCacheFileName	Gets or sets the filename to be used for point map cache.
	PrimaryPort	Gets or sets the eDNA primary port for the adapter's connection.
	PrimaryServer	Gets or sets the name of the eDNA primary server for the adapter's connection.
	ProcessedMeasurements	Gets the total number of measurements handled thus far by the AdapterBase. (Inherited from AdapterBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the output adapter. (Inherited from OutputAdapterBase)
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from OutputAdapterBase)
	RequeueOnException	Gets or sets whether or not to automatically place measurements back into the processing queue if an exception occurs while processing. Defaults to false. (Inherited from OutputAdapterBase)
	RunMetadataSync	Gets or sets whether or not this adapter should automatically manage meta-data for eDNA points.
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterBase)
	SecondaryPort	Gets or sets the eDNA secondary port for the adapter's connection.
	SecondaryServer	Gets or sets the name of the eDNA secondary server for the adapter's connection.
	Service	Gets or sets the eDNA service for the adapter's connection.
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterBase)
	Site	Gets or sets the eDNA site for the adapter's connection.
	StartTime	Gets the UTC time this AdapterBase was started. (Inherited from AdapterBase)
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	Status	Gets the detailed status of the eDNA output adapter. (Overrides OutputAdapterBaseStatus)
	StopTime	Gets the UTC time this AdapterBase was stopped. (Inherited from AdapterBase)
	StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	SupportsTemporalProcessing	Gets the flag indicating if this OutputAdapterBase implementation supports temporal processing. (Inherited from OutputAdapterBase)
	TagNamePrefixRemoveCount	Gets or sets the number of tag name prefixes, e.g., "SOURCE!", applied by subscriptions to remove from eDNA tag names.
	UseAsyncConnect	Returns false to indicate that this OutputAdapter will connect synchronously based on eDNA API operation. (Overrides OutputAdapterBaseUseAsyncConnect)
	ValidateINIFileExists	Gets or sets flag that determines if eDNA client API INI configuration file should be validated to exist before starting adapter. When set to True, adapter will fail to start when INI file does not exist.
	WriteTimeout	Gets or sets the timeout, in milliseconds, for writing data to eDNA connection. A value of -1 will wait indefinitely.

Top

	Name	Description
	AttemptConnection	Connects to the configured eDNA server. (Overrides OutputAdapterBaseAttemptConnection)
	AttemptDisconnection	Closes this OutputAdapter connections to the eDNA server. (Overrides OutputAdapterBaseAttemptDisconnection)
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the OutputAdapter object and optionally releases the managed resources. (Overrides OutputAdapterBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteMetadataRefresh	Sends updated meta-data to eDNA. (Overrides OutputAdapterBaseExecuteMetadataRefresh)
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	Flush	Blocks the current thread, if the OutputAdapterBase is connected, until all items in OutputAdapterBase queue are processed, and then stops processing. (Inherited from OutputAdapterBase)
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Returns a brief status of this OutputAdapter (Overrides AdapterBaseGetShortStatus(Int32))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IncrementProcessedMeasurements	Safely increments the total processed measurements. (Inherited from AdapterBase)
	Initialize	Initializes this OutputAdapter. (Overrides OutputAdapterBaseInitialize)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnConnected	Called when data output source connection is established. (Overrides OutputAdapterBaseOnConnected)
	OnDisconnected	Called when data input source is disconnected. (Inherited from OutputAdapterBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event. (Inherited from AdapterBase)
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event. (Inherited from AdapterBase)
	OnStatusMessage(String)	Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase)
	OnStatusMessage(String, Object)	Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase)
	OnStatusMessage(MessageLevel, String, String, MessageFlags)	Raises the StatusMessage event and sends this data to the Logger. (Inherited from AdapterBase)
	OnUnprocessedMeasurements	Raises the UnprocessedMeasurements event. (Inherited from OutputAdapterBase)
	ProcessMeasurements	Sorts measurements and sends them to the configured eDNA server in batches (Overrides OutputAdapterBaseProcessMeasurements(IMeasurement))
	QueueMeasurementForProcessing	Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys. (Inherited from OutputAdapterBase)
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys. (Inherited from OutputAdapterBase)
	RefreshMetadata	Initiates request for metadata refresh for OutputAdapterBase, if implemented. (Inherited from OutputAdapterBase)
	RemoveMeasurements	This removes a range of measurements from the internal measurement queue. (Inherited from OutputAdapterBase)
	SetInitializedState	Manually sets the initialized state of the AdapterBase. (Inherited from AdapterBase)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from AdapterBase)
	Start	Starts this OutputAdapterBase and initiates connection cycle to data output stream. (Inherited from OutputAdapterBase)
	Stop	Stops this OutputAdapterBase and disconnects from data output stream. (Inherited from OutputAdapterBase)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

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

Top

Reference

eDNAAdapters Namespace