IsActive

(Alarm Manager module)

Description:	Will indicate if an alarm is active. It can be used either as a subroutine or as a called function.
Returns:	Numeric
Usage:	Script or steady state.
Function Groups:	Alarm
Related to:	GetAlarmStatus \| IsShelved \| IsDisabled \| IsUnacked
Format:	\AlarmManager.IsActive(AlarmName[, IncShelving]);
Parameters:

AlarmName

Required.

Unique name for the alarm. Typically the unique ID, which can be obtained using GetAlarmName.
If there are multiple built-in alarms in a tag, the convention is to concatenate the UniqueID with a separator and a unique integer or string per alarm. For example, Concat(Root\UniqueID, \AlarmSeparatorString, 0).

InclShelving

Optional Boolean. If TRUE, a shelved alarm will be reported here as inactive, regardless of its status. Defaults to TRUE.

In most cases, shelving an alarm is considered the same as masking the Active status to FALSE. (Makes it look like inactive, regardless of what it actually is.)

For the rare use cases where shelving is to be ignored, the IncludeShelving parameter can be set to FALSE

Comments:

The IsActive subroutine returns a 1 if the alarm is active, and returns a 0 otherwise.

Example:

Within a custom tag...

  ActiveStatus = \AlarmManager.IsActive(\GetAlarmName(\Root, "Low"));