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, AlertState state) Callback to clear an Alert instance.
default Alarm	getAlarmById(int id)
default boolean	processAlarm(int event, int parm, String cause, String alarmName)

Field Detail

alarms

@LookupField(strategy=TREE)
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,
                                                       AlertState state)

Description copied from interface: ClearAlertHandler

Callback to clear an Alert instance. Return a ClearAlertCode for the provided Alert.

Specified by:

canClearAlert in interface ClearAlertHandler

Parameters:

alert - The Alert instance to clear.

state - The AlertState for the provided Alert.

Returns:

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

getAlarmById

default Alarm getAlarmById(int id)