isAlarmActiveFiltered

New in 7.9.5

This function is used by Ignition's Expression language.

Description

Returns whether there are active alarms that match the provided criteria. It is much more granular than isAlarmActive. The tag path, alarm name, and display path all support wildcards ('*'). The min and max priority expect a number between 0 (diagnostic) and 4 (critical). The pollRate parameter is only applicable in the client scope and is optional.

note

When calling this from the Gateway scope, the Tag Provider must be included in the path.

Syntax

isAlarmActiveFiltered(tagPath, alarmName, displayPath, minPriority, maxPriority, allowCleared, allowAcked, allowShelved[, pollRate])

• Parameters

  • string tagPath - The tag path to search for active alarms. Accepts the wildcard '*'.

  • string alarmName - The alarm name to search for active alarms. Accepts the wildcard '*'.

  • string displayPath - The display path to search for active alarms. Accepts the wildcard '*'.

  • int minPriority - The minimum priority of alarms to accept. 0 is Diagnostic, 1 is Low, 2 is Medium, 3 is High, 4 is Critical.

  • int maxPriority - The maximum priority of alarms to accept. 0 is Diagnostic, 1 is Low, 2 is Medium, 3 is High, 4 is Critical.

  • Bool allowCleared - A flag that indicates whether to accept cleared alarms.

  • Bool allowAcked - A flag that indicates whether to accept acknowledged alarms.

  • Bool allowShelved - A flag that indicates whether to accept shelved alarms.

  • int pollRate - Optional. The poll rate of the function. Only applicable in the Client scope.

• Results

  • Bool - True if there are active alarms, False if there are not.

Examples

Code Snippet

isAlarmActiveFiltered("*", "*", "*", 4, 4, 0, 1, 0)  //when any critical alarm is active, even if acknowledged, then this expression returns True.