AlarmData Class Members
The following tables list the members exposed by AlarmData.
Public Properties
Name | Description | |
---|---|---|
IsConfigError | Gets a value indicating whether the AlarmCntsBySeverity attribute for the specified AssetReference has Configuration error (i.e. object is NOT deployed) | |
IsConnected | Gets a value indicating whether the AlarmCntsBySeverity attribute for the specified AssetReference has Good quality or is Uncertain/Initializing.
There is currently no distinction in this class between Communication/Configuration/Operational errors. | |
IsGood | Gets a value indicating whether the AlarmCntsBySeverity attribute for the specified AssetReference has Good quality. | |
IsInitializing | Gets a value indicating whether the data for the AlarmCntsBySeverity attribute is Initializing. | |
IsUncertain | Gets a value indicating whether the AlarmCntsBySeverity attribute for the specified AssetReference has Uncertain quality. | |
Reference | Gets a reference (e.g. tagname) to a runtime asset (IsCustomHierarchyNode is false), or a hierarchical path if IsCustomHierarchyNode is true. | |
Severity1AckedTotal | Gets a value indicating how many acknowledged severity 1 alarms are associated with this AlarmData. | |
Severity1RtnTotal | Gets a value indicating how many Returned-To-Normal severity 1 alarms are associated with this AlarmData. | |
Severity1UnackedTotal | Gets a value indicating how many unacknowledged severity 1 alarms are associated with this AlarmData. | |
Severity2AckedTotal | Gets a value indicating how many acknowledged severity 2 alarms are associated with this AlarmData. | |
Severity2RtnTotal | Gets a value indicating how many Returned-To-Normal severity 2 alarms are associated with this AlarmData. | |
Severity2UnackedTotal | Gets a value indicating how many unacknowledged severity 2 alarms are associated with this AlarmData. | |
Severity3AckedTotal | Gets a value indicating how many acknowledged severity 3 alarms are associated with this AlarmData. | |
Severity3RtnTotal | Gets a value indicating how many Returned-To-Normal severity 3 alarms are associated with this AlarmData. | |
Severity3UnackedTotal | Gets a value indicating how many unacknowledged severity 3 alarms are associated with this AlarmData. | |
Severity4AckedTotal | Gets a value indicating how many acknowledged severity 4 alarms are associated with this AlarmData. | |
Severity4RtnTotal | Gets a value indicating how many Returned-To-Normal severity 4 alarms are associated with this AlarmData. | |
Severity4UnackedTotal | Gets a value indicating how many unacknowledged severity 4 alarms are associated with this AlarmData. |
Public Methods
Name | Description | |
---|---|---|
Create | Factory method. A new AlarmData will be created if this is the first request for one associated with the specified reference. Otherwise an existing one will be shared.
The caller of this method should call Release() when finished with the received AlarmData, so it can be Disposed() if no other clients exist. | |
Dispose | Overloaded. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ArchestrA.Client.CommonCore.Disposable) | |
HasLocalAlarmOfType | Used for determining whether a specified alarm count contains any alarms directly raised by the object associated with the specified Reference and not aggregated from a child object. | |
Release | Called to release an AlarmData that is no longer required. Internally, a reference count is maintained and the AlarmData will be Disposed() when the last client releases it. |
Protected Methods
Name | Description | |
---|---|---|
Finalize | Finalizes an instance of the ArchestrA.Client.CommonCore.Disposable class. (Inherited from ArchestrA.Client.CommonCore.Disposable) |
Public Events
Name | Description | |
---|---|---|
DataChanged | Raised whenever the data or its quality changes. |
See Also