Detailed Description

The Alarm class is used to generate alarm-events based on signals or component state.

Alarm Usage

Alarms can be used without adding specific code to handle them:

• Add an alarm to a component in the Configure mode.
• Set the alarm configuration in the component configuration by selecting the alarm and setting the alarm properties to desired values.

All CDPAlarms are run as part of the state-machine, and will be automatically processed depending on how they are set up. Depending on how the CDPAlarm is configured with inputs, levels and outputs, it is possible to use CDPAlarm-objects without any coding.

It is also possible to use alarms from code. For instance, add a CDPAlarm for Emergency-stop, e.g. EMStop to the model. The EMStop can now be used in code; Some scenarios are outlined below:

Check if the Emergency-stop alarm is set:

if (EMStop.IsSet())
  HandleEMStop();

Check if the Emergency-stop alarm is Acknowledged:

if (!EMStop.IsUnacknowledged() )
  EquipmentOperatorAcknowledgedEMStop();

To Set or Clear an alarm:

if (alarmShouldBeSet())
  alarm.Set();
else if (alarmShouldBeCleared())
  alarm.Clear();

Alternatively, use the StatusDefines to check alarm status:

if (EMStop.Status()&STATUS_OK)
  RequestOKState();
else if (EMStop.Status()&STATUS_SET)
  PerformEmergencyMeasures();

See below for more information about the different attributes and properties that a CDPAlarm contains.

Alarm status levels

The alarm level signifies the importance of the alarm. The following levels are available:

The alarm Status reflects the set/unset, acknowledged/unacknowledged state of the alarm. The status of the parent CDPComponent will be the or'ed status of all it's alarms (and also the or'ed status of all it's subcomponents).

Properties:

Messages:

The following messages can be sent to the alarm object through CDP Studio, or through a Connector attached to the Alarm:

Alarm Status Defines

#define STATUS_OK                         0x00000000

/** There is a NOTIFY alarm present.*/
#define STATUS_NOTIFY                     0x00000001

/** There is a WARNING alarm present.*/
#define STATUS_WARNING                    0x00000010

/** There is a LOW LEVEL alarm present.*/
#define STATUS_LEVEL_L                    0x00000020

/** There is a HIGH LEVEL alarm present.*/
#define STATUS_LEVEL_H                    0x00000040

/** There is an ERROR alarm present.*/
#define STATUS_ERROR                      0x00000100

/** There is a LOW-LOW LEVEL alarm present. */
#define STATUS_LEVEL_LL                   0x00000200

/** There is a HIGH-HIGH LEVEL alarm present. */
#define STATUS_LEVEL_HH                   0x00000400

/** There is an EMERGENCY alarm present. */
#define STATUS_EMERGENCY                  0x00000800

/** The signal value is forced (overridden). */
#define STATUS_VALUE_FORCED               0x00001000

/** The alarm is blocked due to too many repeats.*/
#define STATUS_REPEATBLOCKED              0x00002000

/** The alarm is blocked by the software. */
#define STATUS_PROCESSBLOCKED             0x00004000

/** The alarm is blocked by the user. */
#define STATUS_OPERATORBLOCKED            0x00008000

/** There is an Unacknowledged NOTIFY alarm present. */
#define STATUS_UNACKNOTIFY                0x00010000

/** There is an Unacknowledged WARNING alarm present. */
#define STATUS_UNACKWARNING               0x00100000

/** There is an Unacknowledged ERROR alarm present. */
#define STATUS_UNACKERROR                 0x01000000

/** There is an Unacknowledged EMERGENCY alarm present. */
#define STATUS_UNACKEMERGENCY             0x08000000

/** The alarm is disabled. */
#define STATUS_DISABLED                   0x20000000

/** The signal has a fault condition present.*/
#define STATUS_SIGNAL_FAULT               0x40000000

/** The component is suspended. */
#define STATUS_COMPONENT_SUSPENDED        0x80000000

/** There is an Unacknowledged alarm present of any level. */
#define STATUS_UNACK_MASK                 (STATUS_UNACKNOTIFY|STATUS_UNACKWARNING|STATUS_UNACKERROR|STATUS_UNACKEMERGENCY)

/** There is an Unacknowledged alarm present of any level. */
#define STATUS_UNACK                      STATUS_UNACK_MASK

/** There is an LOW-LOW ERROR alarm present. */
#define STATUS_ERROR_LL                   (STATUS_ERROR | STATUS_LEVEL_LL)

/** There is an HIGH-HIGH ERROR alarm present. */
#define STATUS_ERROR_HH                   (STATUS_ERROR | STATUS_LEVEL_HH)

/** There is an LOW WARNING alarm present. */
#define STATUS_WARNING_L                  (STATUS_WARNING | STATUS_LEVEL_L)

/** There is an HIGH WARNING alarm present. */
#define STATUS_WARNING_H                  (STATUS_WARNING | STATUS_LEVEL_H)

/** There is an alarm present that is SET. */
#define STATUS_SET                        (STATUS_EMERGENCY|STATUS_ERROR|STATUS_LEVEL_HH|STATUS_LEVEL_LL|STATUS_WARNING|STATUS_LEVEL_L|STATUS_LEVEL_H|STATUS_NOTIFY)

/** There is an EMERGENCY alarm present. */
#define STATUS_LEVEL_EMERGENCY            STATUS_EMERGENCY

/** There is an ERROR alarm present. */
#define STATUS_LEVEL_ERROR                STATUS_ERROR

/** There is an WARNING alarm present. */
#define STATUS_LEVEL_WARNING              STATUS_WARNING

/** There is a NOTIFY alarm present. */
#define STATUS_LEVEL_NOTIFY               STATUS_NOTIFY

/** There is an Unacknowledged NOTIFY alarm present. */
#define STATUS_LEVEL_UNACKNOTIFY          STATUS_UNACKNOTIFY

/** There is an Unacknowledged WARNING alarm present. */
#define STATUS_LEVEL_UNACKWARNING         STATUS_UNACKWARNING

/** There is an Unacknowledged ERROR alarm present. */
#define STATUS_LEVEL_UNACKERROR           STATUS_UNACKERROR