![]() |
Filter
|
public abstract class FilterAdapterBase : AdapterBase, IFilterAdapter, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus
The FilterAdapterBase type exposes the following members.
Name | Description | |
---|---|---|
![]() | FilterAdapterBase | Creates a new instance of the FilterAdapterBase class. |
Name | Description | |
---|---|---|
![]() | AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) |
![]() | ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from AdapterBase) |
![]() | 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 AdapterBase.
(Inherited from AdapterBase) |
![]() | Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) |
![]() | ExecutionOrder | Gets or sets the values that determines the order in which filter adapters are executed. |
![]() | 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.
(Overrides AdapterBaseInputMeasurementKeys) |
![]() | IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) |
![]() | Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
![]() | MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
![]() | Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) |
![]() | OutputMeasurements |
Gets or sets output measurements that the AdapterBase will produce, if any.
(Overrides AdapterBaseOutputMeasurements) |
![]() | 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 adapter.
(Inherited from AdapterBase) |
![]() | RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) |
![]() | Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase) |
![]() | 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 status of this AdapterBase.
(Inherited from AdapterBase) |
![]() | 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 adapter supports temporal processing.
(Inherited from AdapterBase) |
Name | Description | |
---|---|---|
![]() | Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
![]() | Dispose(Boolean) |
Releases the unmanaged resources used by the AdapterBase object and optionally releases the managed resources.
(Inherited from AdapterBase) |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
![]() | Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) |
![]() | GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) |
![]() | GetShortStatus |
Gets a short one-line status of this AdapterBase.
(Overrides AdapterBaseGetShortStatus(Int32)) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object) |
![]() | HandleNewMeasurements | Handler for new measurements that have not yet been routed. |
![]() | IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) |
![]() | Initialize |
Initializes AdapterBase.
(Inherited from AdapterBase) |
![]() | IsInputMeasurement | Determines if the given measurement key represents a signal that is bound for this filter adapter. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
![]() | OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) |
![]() | 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) |
![]() | ProcessMeasurements | Processes the new measurements before they have been routed to other adapters. |
![]() | 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 the AdapterBase or restarts it if it is already running.
(Inherited from AdapterBase) |
![]() | Stop |
Stops the AdapterBase.
(Inherited from AdapterBase) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object) |
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) |
Name | Description | |
---|---|---|
![]() | 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) |
![]() | InputMeasurementKeys |
Returns the MeasurementKey values of the IAdapter input measurements.
(Defined by IAdapterExtensions) |
![]() | 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) |
![]() | OnConfigurationChanged |
Notifies host system of configuration changes.
(Defined by MetadataHelpers) |
![]() | OutputMeasurementKeys |
Returns the MeasurementKey values of the IAdapter output measurements.
(Defined by IAdapterExtensions) |
![]() | PointTagExists |
Determines if pointTag exists in local configuration.
(Defined by MetadataHelpers) |
![]() | SignalIDExists |
Determines if signalID exists in local configuration.
(Defined by MetadataHelpers) |
![]() | SignalReferenceExists |
Determines if signalReference exists in local configuration.
(Defined by MetadataHelpers) |
![]() | 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) |
![]() | WaitForSignalsToLoad |
Waits for signalIDs to be loaded in system configuration.
(Defined by MetadataHelpers) |