Alarm Handler

A global alarm handler callback used to handle Alarm objects in the GLG drawings. More...

Detailed Description

A global alarm handler callback used to handle Alarm objects in the GLG drawings.

Typedefs
typedef void(*	GlgAlarmHandler) (GlgObject data_obj, GlgObject alarm_obj, char *alarm_label, char *action, char *subaction, GlgAnyType reserved)
	An alarm handler used to handle alarms attached to the GLG objects in the drawing and installed via GlgSetAlarmHandler. More...

Typedef Documentation

GlgAlarmHandler

typedef void(* GlgAlarmHandler) (GlgObject data_obj, GlgObject alarm_obj, char *alarm_label, char *action, char *subaction, GlgAnyType reserved)

An alarm handler used to handle alarms attached to the GLG objects in the drawing and installed via GlgSetAlarmHandler.

Alarms are generated by the Alarm objects attached to objects in the drawing and activated when their controlled values go outside the ranges specified in the Alarm objects.

This application-supplied method is invoked to implement custom alarm processing when an alarm occurs.

Parameters

data_obj	The data object the alarm is attached to and whose value has changed.
alarm_obj	The alarm object attached to the data object to monitor its value. It is the alarm that generated the alarm message.
alarm_label	The value of the alarm's AlarmLabel attribute used to identify alarm object.
action	The value of the alarm's AlarmAction attribute, provides details about the condition that caused the alarm.
subaction	The value of the alarm's AlarmSubaction attribute, provides details about the condition that caused the alarm.
reserved	This parameter is reserved for future implementations.

An alarm handler should not change object hierarchy by actions such as adding or deleting objects from the drawing or changing a factor of a series object.

Refer to the Alarm Object section of the GLG User's Guide and Builder Reference Manual for more information.