AlarmCondition
(Function Library)
| Description: | Returns TRUE (1) if the monitored tag has an active alarm. |
| Returns: | Boolean |
Usage: ![]() |
Script or steady state. |
| Function Groups: | Alarm |
| Related to: | AlarmUnAckCondition |
Format: ![]() |
\FunctionLib.AlarmCondition(TagObject) |
| Parameters: |
| TagObject |
| A selected tag that is to be monitored for active 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 active alarms. Trip alarms will not be reported. |
Example:
(Example shows an expression that could be added to an I/O or Calculations tag.)
\FunctionLib.AlarmCondition([Pump 1\Fault])
Will return TRUE (1) when the Pump 1\Fault tag has an active alarm.
