org.lsst.ccs.subsystem.doorman.main

Enum InstrumentType

java.lang.Object

java.lang.Enum<InstrumentType>

org.lsst.ccs.subsystem.doorman.main.InstrumentType

All Implemented Interfaces:

Serializable, Comparable<InstrumentType>

public enum InstrumentType
extends Enum<InstrumentType>

The different kinds of instruments recognized by the subsystem.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILLED_DOOR Motivair ChilledDoor Rack Cooling system.
DUMMY A simulated instrument for testing purposes.

Method Summary

Modifier and Type	Method and Description
String	getConfigName() Gets the instrument type name as it should appear in configuration data.
Instrument	make(InstrumentConfig config) Makes the right kind of Instrument objects using InstrumentConfigs.
static Optional<InstrumentType>	parse(String name) Converts a string to one of the instances of this enum.
static InstrumentType	valueOf(String name) Returns the enum constant of this type with the specified name.
static InstrumentType[]	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

CHILLED_DOOR

public static final InstrumentType CHILLED_DOOR

Motivair ChilledDoor Rack Cooling system.

DUMMY

public static final InstrumentType DUMMY

A simulated instrument for testing purposes.

Method Detail

values

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

Returns:

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

valueOf

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

getConfigName

public String getConfigName()

Gets the instrument type name as it should appear in configuration data.

Returns:

The configuration name.

make

public Instrument make(InstrumentConfig config)

Makes the right kind of Instrument objects using InstrumentConfigs.

Parameters:

config - The configuration information needed to make the new instrument object.

Returns:

The new instrument object.

parse

public static Optional<InstrumentType> parse(String name)

Converts a string to one of the instances of this enum. The string, converted to lower case, should match the configuration name of one of the instances.

Parameters:

name - The string to parse.

Returns:

A full Optional if success, otherwise an empty one.