org.lsst.ccs.subsystem.shutter

Enum Alerts

java.lang.Object

java.lang.Enum<Alerts>

org.lsst.ccs.subsystem.shutter.Alerts

All Implemented Interfaces:

Serializable, Comparable<Alerts>

public enum Alerts
extends Enum<Alerts>

All the alerts that this subsystem can raise.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
MOTION Raised if the Hall data from the last motion indicate a significant deviation from the predicted motion.
MOTOR Raised if some problem has been observed with the motors.
PLC Raised if the shutter controller sends an explicit error message to the subsystem.
STOP_CMD Raised if the subsystem has been given the stopAllMotion() command while in Prod.
SYNC Raised if the PLC state machine and the subsystem state machine appear to have gotten out of sync.
WATCHDOG Raised if no messages have arrived from the shutter controller within a certain period.

Method Summary

Modifier and Type	Method and Description
void	raise(org.lsst.ccs.services.alert.AlertService alertSvc, org.lsst.ccs.bus.states.AlertState severity, String cause, org.lsst.ccs.services.alert.AlertService.RaiseAlertStrategy strategy) Raises the alert associated with this enumeration member.
static void	registerAll(org.lsst.ccs.services.alert.AlertService alertSvc)
static Alerts	valueOf(String name) Returns the enum constant of this type with the specified name.
static Alerts[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYNC

public static final Alerts SYNC

Raised if the PLC state machine and the subsystem state machine appear to have gotten out of sync.

PLC

public static final Alerts PLC

Raised if the shutter controller sends an explicit error message to the subsystem.

WATCHDOG

public static final Alerts WATCHDOG

Raised if no messages have arrived from the shutter controller within a certain period.

MOTION

public static final Alerts MOTION

Raised if the Hall data from the last motion indicate a significant deviation from the predicted motion.

MOTOR

public static final Alerts MOTOR

Raised if some problem has been observed with the motors. For example temperature out of the safe operating range.

STOP_CMD

public static final Alerts STOP_CMD

Raised if the subsystem has been given the stopAllMotion() command while in Prod.

Method Detail

values

public static Alerts[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Alerts c : Alerts.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Alerts valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

raise

public void raise(org.lsst.ccs.services.alert.AlertService alertSvc,
                  org.lsst.ccs.bus.states.AlertState severity,
                  String cause,
                  org.lsst.ccs.services.alert.AlertService.RaiseAlertStrategy strategy)

Raises the alert associated with this enumeration member.

Parameters:

alertSvc - the CCS alert service.

severity - the state which the raised alert is to have.

cause - the cause string which the raised alert is to have.

registerAll

public static void registerAll(org.lsst.ccs.services.alert.AlertService alertSvc)