​.Alarm dotfield

Returns 0 when a specified tag or alarm group is not currently in an alarm state. When an alarm occurs, the .Alarm dotfield returns 1. It remains at 1 until the alarm condition no longer exists. The .Alarm dotfield has an inverse dotfield called .Normal.

If the specified tag is the name of an alarm group, the .Alarm dotfield returns 1 if any of the tags that belong to the group are in an alarm state.

Category

Alarms

Usage

TagName.Alarm

Parameter

TagName

Any discrete, integer, real tag, indirect discrete and analog tag, or alarm group tag.

Data Type

Discrete (read-only)

Valid Values

0 or 1

Example

The following statement verifies if Tag1 has an active alarm associated with it:

IF (Tag1.Alarm == 1) THEN

The body of this IF-THEN statement is processed if active alarms exist within the PumpStation alarm group.

IF (PumpStation.Alarm == 1) THEN

MyAlarmMessage="The pumping station currently has an ALARM!";

ENDIF;

This dotfield is not linked to the .Ack or .UnAck dotfields. Therefore, even when an active alarm has been acknowledged, .Alarm remains equal to 1.