org.lsst.ccs.subsystem.shutter.statemachine

Enum PhysicalState

java.lang.Object

java.lang.Enum<PhysicalState>

org.lsst.ccs.subsystem.shutter.statemachine.PhysicalState

All Implemented Interfaces:

Serializable, Comparable<PhysicalState>

public enum PhysicalState
extends Enum<PhysicalState>

Descriptions of the current state of the shutter as reported to OCS, regardless of the internal state of the state machine used by the subsystem to control the shutter. These are the states used in the state bundle for the subsystem.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTERED Prepared for power-off.
CLOSED Fully closed.
CLOSING On the way from being fully opened or traveling to being fully closed.
ENG_MOVING Non-standard blade set motion.
OPENED Fully opened.
OPENING On the way from being closed to opened.
OTHER The blade set positions are either unknown or don't fit into any of the other categories.
TRAVELING Traveling slit.

Method Summary

Modifier and Type	Method and Description
static PhysicalState	valueOf(String name) Returns the enum constant of this type with the specified name.
static PhysicalState[]	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

CLOSED

public static final PhysicalState CLOSED

Fully closed. One blade set is fully retracted and the other is fully extended.

OPENING

public static final PhysicalState OPENING

On the way from being closed to opened. One blade set is retracting.

OPENED

public static final PhysicalState OPENED

Fully opened. Both blade sets are fully retracted.

TRAVELING

public static final PhysicalState TRAVELING

Traveling slit. Due to a very short exposure time we started closing the shutter before it had become fully opened. Both blade sets are in motion, one retracting and the other extending.

CLOSING

public static final PhysicalState CLOSING

On the way from being fully opened or traveling to being fully closed. One blade set is fully retracted and the other is still being extended.

CENTERED

public static final PhysicalState CENTERED

Prepared for power-off. Both blade sets are half-extended.

ENG_MOVING

public static final PhysicalState ENG_MOVING

Non-standard blade set motion. A blade set is being moved in some way other than with the subsystem commands closeShutter(), openShutter() or takeExposure(). Covers Hall calibration and other engineering-mode activities.

OTHER

public static final PhysicalState OTHER

The blade set positions are either unknown or don't fit into any of the other categories.

Method Detail

values

public static PhysicalState[] 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 (PhysicalState c : PhysicalState.values())
    System.out.println(c);

Returns:

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

valueOf

public static PhysicalState 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