|
Device
|
Represents an adapter that will monitor and report device alarm states.
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersFacileActionAdapterBase
GrafanaAdaptersDeviceAlarmStateAdapter
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersFacileActionAdapterBase
GrafanaAdaptersDeviceAlarmStateAdapter
Namespace: GrafanaAdapters
Assembly: GrafanaAdapters (in GrafanaAdapters.dll) Version: 2.4.230-beta
SyntaxThe DeviceAlarmStateAdapter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DeviceAlarmStateAdapter | Creates a new DeviceAlarmStateAdapter. |
Properties| Name | Description | |
|---|---|---|
 | AcknowledgedTransitionHysteresisDelay | Gets or sets delay time, in minutes, before transitioning the Acknowledged state back to Good. |
| AlarmMinutes | Gets or sets the time, in minutes, for which to change the device state to alarm when no data is received. |
| 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) |
| EnableExternalDatabaseSynchronization | Gets or sets the flag that determines if an external database connection should be enabled for synchronization of alarm states. |
| ExternalDatabaseCommand | Gets or sets the external database command used for synchronization of alarm states. |
| ExternalDatabaseCommandParameters | Gets or sets the external database command parameters with value substitutions used for synchronization of alarm states. |
| ExternalDatabaseConnectionString | Gets or sets the external database connection string used for synchronization of alarm states. Leave blank to use local configuration database defined in "systemSettings". |
| ExternalDatabaseHysteresisDelay | Gets or sets the delay time, in minutes, before reporting the external database state. |
| ExternalDatabaseHysteresisMinimumState | Gets or sets the minimum state for application of ExternalDatabaseHysteresisDelay. Defaults to setting Good and Alarm states immediately and applying delay to all other states. |
| ExternalDatabaseMappedAlarmStates | Gets or sets the external database mapped alarm states defining the {MappedAlarmState} command parameter substitution parameter used for synchronization of alarm states. |
| ExternalDatabaseProviderString | Gets or sets the external database provider string used for synchronization of alarm states. |
| ExternalDatabaseReportSingleCompositeState | Gets or sets the flag that determines if external database should report a single composite state or a state for each device. |
| FallBackOnLocalClock |
Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable.
(Inherited from FacileActionAdapterBase) |
| FramesPerSecond |
Gets or sets the frames per second to be used by the FacileActionAdapterBase.
(Inherited from FacileActionAdapterBase) |
| 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 adapter expects, if any.
(Overrides FacileActionAdapterBaseInputMeasurementKeys) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurement keys.
(Inherited from FacileActionAdapterBase) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase) |
| LagTime |
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
(Inherited from FacileActionAdapterBase) |
| LatestMeasurements |
Gets reference to the collection of absolute latest received measurement values.
(Inherited from FacileActionAdapterBase) |
| LeadTime |
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
(Inherited from FacileActionAdapterBase) |
 | Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
| MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
| MonitoringRate | Gets or sets monitoring rate, in milliseconds, for devices. |
| Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) |
| OutputMeasurements |
Gets or sets output measurements that the adapter will produce, if any.
(Overrides AdapterBaseOutputMeasurements) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from FacileActionAdapterBase) |
| 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) |
| RealTime |
Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then
this function will return UtcNow. Otherwise, this function will return the timestamp of the
most recent measurement.
(Inherited from FacileActionAdapterBase) |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from FacileActionAdapterBase) |
| RespectInputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from FacileActionAdapterBase) |
| RespectOutputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from FacileActionAdapterBase) |
| 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 |
Returns the detailed status of the data input source.
(Overrides FacileActionAdapterBaseStatus) |
| 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.
(Overrides AdapterBaseSupportsTemporalProcessing) |
| TargetParentDevices | Gets or sets the flag that determines if alarm states should only target parent devices, i.e., PDCs and direct connect PMUs, or all devices. |
| TrackLatestMeasurements |
Gets or sets flag to start tracking the absolute latest received measurement values.
(Inherited from FacileActionAdapterBase) |
| UseLocalClockAsRealTime |
Gets or sets flag that determines whether or not to use the local clock time as real time.
(Inherited from FacileActionAdapterBase) |
Methods| Name | Description | |
|---|---|---|
| Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the DeviceAlarmStateAdapter object and optionally releases the managed resources.
(Overrides AdapterBaseDispose(Boolean)) |
| 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) |
 | GetShortElapsedTimeString | Get short elapsed time string for specified span. |
| GetShortStatus |
Gets a short one-line status of this adapter.
(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 DeviceAlarmStateAdapter.
(Overrides FacileActionAdapterBaseInitialize) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from AdapterBase) |
| OnDiscardingMeasurements |
Raises the DiscardingMeasurements event.
(Inherited from FacileActionAdapterBase) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase) |
| OnNewMeasurements |
Raises the NewMeasurements event.
(Inherited from FacileActionAdapterBase) |
| 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) |
| OnUnpublishedSamples |
Raises the UnpublishedSamples event.
(Inherited from FacileActionAdapterBase) |
| QueueMeasurementForProcessing |
Queues a single measurement for processing.
(Inherited from FacileActionAdapterBase) |
| QueueMeasurementsForProcessing |
Queues a collection of measurements for processing.
(Inherited from FacileActionAdapterBase) |
| QueueStateUpdate | Queues monitoring operation to update alarm state for immediate execution. |
| 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) |
| UpdateAlarmStates | Updates alarm states from database. |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase) |
| DiscardingMeasurements |
This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from FacileActionAdapterBase) |
| Disposed |
Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase) |
| NewMeasurements |
Provides new measurements from action adapter.
(Inherited from FacileActionAdapterBase) |
| 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) |
| UnpublishedSamples |
This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue.
(Inherited from FacileActionAdapterBase) |
Fields| Name | Description | |
|---|---|---|
 | DefaultAcknowledgedTransitionHysteresisDelay | Defines the default value for the AcknowledgedTransitionHysteresisDelay. |
| DefaultAlarmMinutes | Defines the default value for the AlarmMinutes. |
| DefaultExternalDatabaseHysteresisDelay | Defines the default value for the DefaultExternalDatabaseHysteresisDelay. |
| DefaultMonitoringRate | Defines the default value for the MonitoringRate. |
See Also