org.lsst.ccs.subsystem.shutter.plc

Enum BladeSetPosition

java.lang.Object

java.lang.Enum<BladeSetPosition>

org.lsst.ccs.subsystem.shutter.plc.BladeSetPosition

All Implemented Interfaces:

Serializable, Comparable<BladeSetPosition>

public enum BladeSetPosition
extends Enum<BladeSetPosition>

Names of several blade set positions of special importance. Associated with each position is a key string used with configuration file maps.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTERED Move the blade set here to center it prior to shutting off the shutter.
EXTENDED As far or farther from home than this and the blade set is considered fully extended.
HOME The most retracted position possible without running into soft or hard motion limits.
RETRACTED This close or closer to home and the blade set is considered fully retracted.

Method Summary

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

HOME

public static final BladeSetPosition HOME

The most retracted position possible without running into soft or hard motion limits.

RETRACTED

public static final BladeSetPosition RETRACTED

This close or closer to home and the blade set is considered fully retracted.

CENTERED

public static final BladeSetPosition CENTERED

Move the blade set here to center it prior to shutting off the shutter.

EXTENDED

public static final BladeSetPosition EXTENDED

As far or farther from home than this and the blade set is considered fully extended.

Method Detail

values

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

Returns:

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

valueOf

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

getKey

public String getKey()

Gets the associated map key.

Returns:

The key string.