org.lsst.ccs.monitor

Class Alarm

java.lang.Object

org.lsst.ccs.monitor.Alarm

All Implemented Interfaces:

HasLifecycle

Direct Known Subclasses:

AlertRaisingAlarm

public class Alarm
extends Object
implements HasLifecycle

Implements alarms.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description Data fields.
static int	EVENT_LIMBO Constants.
static int	EVENT_LIMBO_FROM_ERROR Constants.
static int	EVENT_LIMBO_FROM_GOOD Constants.
static int	EVENT_RESET Constants.
static int	EVENT_TRIP Constants.
protected int	eventParm
protected boolean	ignoreAlarmHandlers
protected String	name

Constructor Summary

Constructors

Constructor and Description
Alarm()
Alarm(Alert alert)

Method Summary

Modifier and Type	Method and Description
void	build() First lifecycle hook.
boolean	canClearState()
void	clearState()
Alert	getAlert(AlertState alertState, AlertState previousAlertState) Get the Alert to be raised at the given AlertState.
static AlertState	getAlertStateFromEventId(int event) Get the AlertState corresponding to the event id used by AlarmHandlers
String	getName()
void	init() Called from the enclosing Subsystem at initialization phase.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

EVENT_TRIP

public static final int EVENT_TRIP

Constants.

See Also:

Constant Field Values

EVENT_LIMBO

public static final int EVENT_LIMBO

Constants.

See Also:

Constant Field Values

EVENT_LIMBO_FROM_ERROR

public static final int EVENT_LIMBO_FROM_ERROR

Constants.

See Also:

Constant Field Values

EVENT_LIMBO_FROM_GOOD

public static final int EVENT_LIMBO_FROM_GOOD

Constants.

See Also:

Constant Field Values

EVENT_RESET

public static final int EVENT_RESET

Constants.

See Also:

Constant Field Values

description

protected String description

Data fields.

eventParm

protected int eventParm

ignoreAlarmHandlers

protected boolean ignoreAlarmHandlers

name

@LookupName
protected String name

Constructor Detail

Alarm

public Alarm()

Alarm

public Alarm(Alert alert)

Method Detail

build

public void build()

Description copied from interface: HasLifecycle

First lifecycle hook. Modification of the component tree is allowed at this stage. After this stage the tree of component cannot be modified anymore. This is where agent periodic tasks should be scheduled.

Specified by:

build in interface HasLifecycle

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at initialization phase.

This method is called before the children components of this object have their init method called.

At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.

It is unnecessary to call super.init()

Specified by:

init in interface HasLifecycle

getAlert

public Alert getAlert(AlertState alertState,
                      AlertState previousAlertState)

Get the Alert to be raised at the given AlertState. The Alarm has been triggered and it's time to raise an Alert. If the provided Alert is null, no alert will be raised.

Parameters:

alertState - The State at which the Alert will be raised.

previousAlertState - The previous state in this state transition.

Returns:

The Alert to be raised.

getAlertStateFromEventId

public static AlertState getAlertStateFromEventId(int event)

Get the AlertState corresponding to the event id used by AlarmHandlers

Parameters:

event - The event Id.

Returns:

The corresponding AlertState

clearState

public void clearState()

canClearState

public boolean canClearState()

getName

public String getName()