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

Enum ThermalState

java.lang.Object

java.lang.Enum<ThermalState>

org.lsst.ccs.subsystem.common.devices.refrigeration.states.ThermalState

All Implemented Interfaces:

Serializable, Comparable<ThermalState>

public enum ThermalState
extends Enum<ThermalState>

Thermal State of Cold/Cryo device with respect to the ThermalTarget.

Author:

The LSST CCS Team

Enum Constant Summary

Enum Constants

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

Method Summary

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

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

AT_TARGET

public static final ThermalState AT_TARGET

The ThermalTarget has been reached.

IN_TRANSITION

public static final ThermalState IN_TRANSITION

The system is transitioning to a new ThermalTarget.

OFF_TARGET

public static final ThermalState OFF_TARGET

The system is off the set ThermalTarget.

Method Detail

values

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

Returns:

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

valueOf

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