PTMAP_fold_ack_state

The standard point states are:

• PTM_NORMAL
• PTM_ALARM_HIGH
• PTM_ALARM_LOW
• PTM_WARNING_HIGH
• PTM_WARNING_LOW
• PTM_ALARM
• PTM_WARNING
• PTM_AVAILABLE
• PTM_OUT_OF_RANGE
• PTM_UNAVAILABLE

Whenever an alarm that was generated by Point Management is acknowledged by any source, the Alarm Manager sends notification of that fact to the Point Manager. This information is passed by Point Manager to all PTMAP clients in the PTM_RSP structure.

The additional point states that reflect point acknowledgment are:

• PTM_NORMAL_NOACK
• PTM_ALARM_HIGH_NOACK
• PTM_ALARM_LOW_NOACK
• PTM_WARNING_HIGH_NOACK
• PTM_WARNING_LOW_NOACK
• PTM_ALARM_NOACK
• PTM_WARNING_NOACK
• PTM_AVAILABLE_NOACK
• PTM_OUT_OF_RANGE_NOACK
• PTM_UNAVAILABLE_NOACK

This subroutine lets you fold the NOACK state of a point into the standard point state, and create the additional point states. These additional point states are recognized by the expression processor that is used for derived points and for graphic object annunciation.

Syntax

int PTMAP_fold_ack_state (state, ack_occurred)
PTM_POINT_STATE state;
int             ack_occurred;

Input Arguments

Output Arguments

None.

Return Value

New alarm state. If the alarm has been acknowledged, the original alarm state is returned. If the alarm has not been acknowledged, one of the "NOACK" states will be returned.