AlarmUnAckCondition
(Function Library)
| Description: | Returns TRUE (1) if the monitored tag has an unacknowledged alarm. |
| Returns: | Boolean |
Usage:  |
Script or steady state. |
| Function Groups: | Alarm |
| Related to: | AlarmCondition |
| Format: |
\FunctionLib.AlarmUnAckCondition(TagObject) |
| Parameters: |
| TagObject |
| A selected tag that is to be monitored for unacknowledged alarms. |
| Comments: |
This module is a member of the Function Library, and must therefore be prefaced by \FunctionLib as shown in the "Format" section. Monitors only for unacknowledged alarms. Trip alarms will be reported. |
Example:
Example shows an expression that could be added to the user interface (such as within an I/O or Calculations tag) rather than a script code file.
\FunctionLib.AlarmUnAckCondition([Pump 1\Fault])
Will return TRUE (1) when the Pump 1\Fault tag has an unacknowledged alarm.
