org.lsst.ccs.subsystem.monitor

Class Alarm

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Alarm

All Implemented Interfaces:

ConfigurationBulkChangeHandler, Configurable, HasLifecycle, UsesSubsystem

public class Alarm
extends ConfigurableComponent
implements HasLifecycle

Implements alarms.

Author:

Owen Saxton

Nested Class Summary

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

Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_LIMBO Constants.
static int	EVENT_RESET Constants.
static int	EVENT_TRIP Constants.

Constructor Summary

Constructors

Constructor and Description
Alarm() The empty constructor.
Alarm(String lineName, int eventParm) Deprecated.
Alarm(String description, String lineName, int eventParm) Deprecated. To be removed if not needed internally, in which case it should not be public.

Method Summary

Modifier and Type	Method and Description
void	init() Called from the enclosing Subsystem at construction 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

postInit, postStart, shutdownNow, start

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

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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_RESET

public static final int EVENT_RESET

Constants.

See Also:

Constant Field Values

Constructor Detail

Alarm

public Alarm()

The empty constructor. TODO: remove once the other constructors have been removed.

Alarm

@Deprecated
public Alarm(String description,
                         String lineName,
                         int eventParm)

Deprecated. To be removed if not needed internally, in which case it should not be public.

Constructor.

Parameters:

description - The alarm description

lineName - The name of the associated line, or null

eventParm - The parameter to be passed to the alarm handler, or -1 if no handler

Alarm

@Deprecated
public Alarm(String lineName,
                         int eventParm)

Deprecated.

Constructor.

Parameters:

lineName - The name of the associated line, or null

eventParm - The parameter to be passed to the alarm handler, or -1 if no handler

Method Detail

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at construction 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