GetAlarmStateStats

TagName may be a context or other parent, in which case statistics will be gathered for all of the child tags.

It may also be Code, in order to retrieve statistics about the whole application.

Information returned by this function is not limited by realm-area filtering.

The return structure includes the following elements:

ActiveCount { Total Active alarms including descendents };
UnackedCount { Total Unacked alarms including descendents };
ShelvedCount { Total Shelved alarms including descendents };
DisabledCount { Total Disabled alarms including descendents };
SuppressedCount { Total Suppressed alarms including descendents };
HighestActivePriority { Highest priority of active alarms including descendents };
HighestUnackedPriority { Highest priority of unacked alarms including descendents };
ActivePriorities { Dictionary of counts of active alarms for each priority, including descendents };
UnackedPriorities { Dictionary of counts of unacked alarms for each priority, including descendents }

The dictionaries, ActivePriorities and UnackedPriorities are keyed by alarm priority numbers, which are padded with zeros. For example, the key to access the count of Critical active alarms is "0001".

These dictionaries will return an invalid if there are no alarms that match your query. A valid value will not be returned until a specified alarm has been generated. To protect against an invalid return from the expression, especially if value returned is to be included in reports or displayed on a screen, the expression should be wrapped in a PickValid() so a valid value will always be returned. For example: PickValid(\AlarmManager.GetAlarmStateStats(\Root).ActivePriorities["0001"], 0)