org.lsst.ccs.subsystem.shutter.common

Enum Axis

java.lang.Object

java.lang.Enum<Axis>

org.lsst.ccs.subsystem.shutter.common.Axis

All Implemented Interfaces:

Serializable, Comparable<Axis>

public enum Axis
extends Enum<Axis>

The axes available on the shutter, one per blade set. The actual axis number used in the PLC and the axis name are instance fields.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AXIS0
AXIS1

Method Summary

Modifier and Type	Method and Description
static Axis	fromAxisNum(int axnum) Find the Axis value having the given PLC axis number.
static Axis	fromName(String name) Find the Axis value having the given axis name using a case-insensitive search.
static Axis	getMinusXSide() Gets the axis that's controlling the blade set on the -X side.
String	getName() The name used for the axis in motorplatform commands.
int	getPLCAxisNum() The axis number used by the PLC code.
static Axis	getPlusXSide() Gets the axis that's controlling the blade set on the +X side.
boolean	isPlusXSide() Tells whether the axis is for the +X blade set or the -X.
static Axis	valueOf(String name) Returns the enum constant of this type with the specified name.
static Axis[]	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

AXIS0

public static final Axis AXIS0

AXIS1

public static final Axis AXIS1

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

The name used for the axis in motorplatform commands.

Returns:

The axis name string.

getPLCAxisNum

public int getPLCAxisNum()

The axis number used by the PLC code.

Returns:

The axis number.

fromName

public static Axis fromName(String name)

Find the Axis value having the given axis name using a case-insensitive search.

Parameters:

name - The axis name to find.

Returns:

The corresponding Axis value, or null if no match was found.

fromAxisNum

public static Axis fromAxisNum(int axnum)

Find the Axis value having the given PLC axis number.

Parameters:

axnum - The PLC axis number to find.

Returns:

The corresponding Axis value, or null if no match was found.

isPlusXSide

public boolean isPlusXSide()

Tells whether the axis is for the +X blade set or the -X.

Returns:

true if it's the axis for the +X blade set.

getPlusXSide

public static Axis getPlusXSide()

Gets the axis that's controlling the blade set on the +X side.

Returns:

The axis.

getMinusXSide

public static Axis getMinusXSide()

Gets the axis that's controlling the blade set on the -X side.

Returns:

The axis.