(Hierarchical Accumulator module)
| Description: | Returns the current count of the values within an accumulator dictionary. |
| Returns: | Numeric |
Usage:  |
Script or steady state. |
| Function Groups: | Variable |
| Related to: | Accumulate |
| Format: |
HierarchicalAccumulator\GetValue(TagObj, AccumulatorName); |
| Parameters: |
| TagObj |
| Required. The tag object at the point in the hierarchy where you want to collect the accumulated values. |
| AccumulatorName |
| Required. The name of the accumulator, from which to retrieve the current count. |
| Comments: | This function is part of the HierarchicalAccumulator module, so must always be called as shown in the format. You will need this function if you have created your own accumulator and wish to retrieve the value.
The accumulator allows a fresh count to be generated at different levels in a tag tree, and as tags are moved or disabled. |
Examples:
Main [ Return(\HierarchicalAccumulator\GetValue(ContainerObj, "AlarmUnacked")); ]
