org.lsst.ccs.subsystem.shutter.common

Enum SoftwareState

java.lang.Object

java.lang.Enum<SoftwareState>

org.lsst.ccs.subsystem.shutter.common.SoftwareState

All Implemented Interfaces:

Serializable, Comparable<SoftwareState>

public enum SoftwareState
extends Enum<SoftwareState>

Describes the internal state of the CCS worker subsystem used to control the shutter. Reported as part of the state bundle of the running subsystem. Only non-composite states have members, composite states show up in the descriptions. For example, a state Foo which is a sub-state of the composite state Bar will have the description "Foo in Bar".

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALIBRATING The shutter controller is performing a calibration (Maint mode).
CENTERING1 The first blade set is moving to its center position (Maint mode).
CENTERING2 The second blade set is moving to its center position (Maint mode).
CLOSED The shutter is closed (Prod mode).
CLOSING The shutter is closing (Prod mode).
DISABLED Hardware protection logic has disabled operation of the shutter.
MOVING A blade set is moving in response to a single-axis motion command (Maint mode).
OPENED The shutter is open (Prod mode).
OPENING The shutter is opening (Prod mode).
STILL Blade sets are motionless (Maint mode).
SYNC_ERROR Lost contact with the shutter controller or timed out in the Synchronizing state.
SYNCHRONIZING Waiting for the shutter controller to enter its Still or Disabled state after a reset.
TRAVELING The shutter is performing a traveling-slit exposure (Prod mode).

Method Summary

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

SYNCHRONIZING

public static final SoftwareState SYNCHRONIZING

Waiting for the shutter controller to enter its Still or Disabled state after a reset.

SYNC_ERROR

public static final SoftwareState SYNC_ERROR

Lost contact with the shutter controller or timed out in the Synchronizing state.

DISABLED

public static final SoftwareState DISABLED

Hardware protection logic has disabled operation of the shutter.

STILL

public static final SoftwareState STILL

Blade sets are motionless (Maint mode).

MOVING

public static final SoftwareState MOVING

A blade set is moving in response to a single-axis motion command (Maint mode).

CALIBRATING

public static final SoftwareState CALIBRATING

The shutter controller is performing a calibration (Maint mode).

CENTERING1

public static final SoftwareState CENTERING1

The first blade set is moving to its center position (Maint mode).

CENTERING2

public static final SoftwareState CENTERING2

The second blade set is moving to its center position (Maint mode).

CLOSED

public static final SoftwareState CLOSED

The shutter is closed (Prod mode).

OPENING

public static final SoftwareState OPENING

The shutter is opening (Prod mode).

TRAVELING

public static final SoftwareState TRAVELING

The shutter is performing a traveling-slit exposure (Prod mode).

OPENED

public static final SoftwareState OPENED

The shutter is open (Prod mode).

CLOSING

public static final SoftwareState CLOSING

The shutter is closing (Prod mode).

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()