org.lsst.ccs.monitor

Interface Monitor.AlarmHandler

All Superinterfaces:

AlertHandler, ClearAlertHandler

Enclosing class:

Monitor

public static interface Monitor.AlarmHandler
extends ClearAlertHandler

Interface for handling alarm events.

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
static List<Alarm>	alarms

Method Summary

Modifier and Type	Method and Description
default ClearAlertHandler.ClearAlertCode	canClearAlert(Alert alert) Callback to clear an Alert instance.
default Alarm	getAlarmById(int id)
default boolean	processAlarm(int event, int parm, String cause, String alarmName)
default void	setAlarms(List<Alarm> alarms)

Field Detail

alarms

static final List<Alarm> alarms

Method Detail

processAlarm

default boolean processAlarm(int event,
                             int parm,
                             String cause,
                             String alarmName)

canClearAlert

default ClearAlertHandler.ClearAlertCode canClearAlert(Alert alert)

Description copied from interface: ClearAlertHandler

Callback to clear an Alert instance. Return true/false if the Alert can be cleared. When true is returned the Alert is cleared and no more handlers will be checked. When false is returned other handlers will be handed the Alert instance to be cleared. If no handler returns true, the Alert will not be cleared.

Specified by:

canClearAlert in interface ClearAlertHandler

Parameters:

alert - The Alert instance to clear.

Returns:

A ClearAlertCode to indicate which action is to be taken by the framework.

setAlarms

default void setAlarms(List<Alarm> alarms)

getAlarmById

default Alarm getAlarmById(int id)