org.lsst.ccs.subsystem.common.devices.vacuum.states

Enum VacuumState

java.lang.Object

java.lang.Enum<VacuumState>

org.lsst.ccs.subsystem.common.devices.vacuum.states.VacuumState

All Implemented Interfaces:

Serializable, Comparable<VacuumState>

public enum VacuumState
extends Enum<VacuumState>

Vacuum State with respect to the VacuumTarget.

Author:

The LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_TARGET The VacuumTarget has been reached.
IN_TRANSITION The system is transitioning to a new VacuumTarget.
OFF_TARGET The system is off the set VacuumTarget.
UNKNOWN The initial thermal state.

Method Summary

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

UNKNOWN

public static final VacuumState UNKNOWN

The initial thermal state. Will migrate to a well defined state when enough information is gathered.

AT_TARGET

public static final VacuumState AT_TARGET

The VacuumTarget has been reached.

IN_TRANSITION

public static final VacuumState IN_TRANSITION

The system is transitioning to a new VacuumTarget.

OFF_TARGET

public static final VacuumState OFF_TARGET

The system is off the set VacuumTarget.

Method Detail

values

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

Returns:

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

valueOf

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