org.lsst.ccs.bus.data

Enum RunMode

java.lang.Object

java.lang.Enum<RunMode>

org.lsst.ccs.bus.data.RunMode

All Implemented Interfaces:

Serializable, Comparable<RunMode>

public enum RunMode
extends Enum<RunMode>

An enumeration to distinguish between a NORMAL and SIMULATED subsystem.

Author:

The LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL
SIMULATION

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_RUNMODE_PROPERTY
static String	RUNMODE_SYSTEM_PROPERTY

Method Summary

Modifier and Type	Method and Description
static RunMode	getRunMode()
static boolean	isSimulation() This method opens Bootstrap resources/files to assess if property org.lsst.ccs.run.mode has been set to true/false.
static RunMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RunMode[]	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

NORMAL

public static final RunMode NORMAL

SIMULATION

public static final RunMode SIMULATION

Field Detail

AGENT_RUNMODE_PROPERTY

public static final String AGENT_RUNMODE_PROPERTY

See Also:

Constant Field Values

RUNMODE_SYSTEM_PROPERTY

public static final String RUNMODE_SYSTEM_PROPERTY

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getRunMode

public static RunMode getRunMode()

isSimulation

public static boolean isSimulation()

This method opens Bootstrap resources/files to assess if property org.lsst.ccs.run.mode has been set to true/false.

Returns:

true/false to indicate if we are in simulation mode.