Click or drag to resize
Grid Solutions Framework

OutputAdapter Properties

The OutputAdapter type exposes the following members.

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