GetContainerNumUnacked
(Alarm Manager module)
Description: | Returns the number of unacknowledged alarms within a hierarchy of tags. |
Returns: | Numeric |
Usage: | Script or steady state. |
Function Groups: | Alarm Manager |
Related to: | Accumulate | GetContainerNumActive |
Format: | GetContainerNumUnacked(ContainerObj); |
Parameters: |
ContainerObj |
Required. The container tag to query. |
Comments: | In earlier versions of VTScada, if you had written a custom tag with a built-in alarm, you had to ensure that it contributed its unacknowledged alarms to the count maintained by a hierarchical accumulator module. This is no longer true. |
Example:
TotalNumUnacked = \AlarmManager\GetContainerNumUnacked(MyTagName);
Example 2:
Given a Context-derived tag at the top level of the tag hierarchy named "Station 1", suppose that you want an expression in a calculation tag that will return the total number of unacknowledged alarms in that context. The expression would be:
\AlarmManager\GetContainerNumUnacked([<Station 1>]\Root)