NumAlarm

Description: This function returns the number of alarms in one of the four alarm lists within given level and category limits.

Returns: Numeric

Usage: Script or Steady State

Format: NumAlarm(List, LowLevel, HighLevel, LowCategory, HighCategory)

Parameters: List { numeric } { required } { no default }

Any numeric expression giving the list number to search for the alarm. The valid list numbers are:

List	List to search
0	Logged alarm list
1	Active alarm list
2	Unacknowledged alarm list
3	Current alarm list Added to these list numbers can be one of the following numbers which further modify the list chosen:

Modifier	Attributes
4	Use combined alarm list
8	Don't include alarm occurrences in list
16	Don't include alarm clears in list
32	Don't include alarm acknowledges in list
64	Don't include alarm enables in list
128	Don't include alarm disables in list

LowLevel { numeric } { required } { no default }

Any numeric expression giving the lower limit for the alarm priority level. If the alarm level is strictly below this value, the alarm is not included in the count.

HighLevel { numeric } { required } { no default }

Any numeric expression giving the upper limit for the alarm priority level. If the alarm level is strictly above this value, the alarm is not included in the count.

LowCategory { numeric } { required } { no default }

Any numeric expression giving the lower limit for the alarm category. If the alarm category is strictly below this value, the alarm is not included in the count.

HighCategory { numeric } { required } { no default }

Any numeric expression giving the upper limit for the alarm category. If the alarm category is strictly above this value, the alarm is not included in the count.

Comments: This function is useful for determining the existence of any alarm of specific levels or categories.

Example:

ZText(20, 20 { Coordinates for text },

Concat("There are " { Text to display },

NumAlarm(1, 0, 15, 3, 3)

{ No. of active cat 3 alarms only },

"category 3 alarms!),

12, 0 { Light red color, default font });

This statement displays the number of active category 3 alarms.