org.lsst.ccs.drivers.parker

Enum AxisName

java.lang.Object

java.lang.Enum<AxisName>

org.lsst.ccs.drivers.parker.AxisName

All Implemented Interfaces:

Serializable, Comparable<AxisName>

public enum AxisName
extends Enum<AxisName>

Defines names for eight of the 16 possible axes. Each axis is controlled by a master and controls one or two encoders; one encoder for position and perhaps another for velocity.

Author:

tether

See Also:

MasterName, EncoderName

Enum Constant Summary

Enum Constants

Enum Constant and Description
AXIS0
AXIS1
AXIS2
AXIS3
AXIS4
AXIS5
AXIS6
AXIS7

Method Summary

Modifier and Type	Method and Description
int	index() Gets the motor controller's index number of the axis.
String	reference() Gets the string used to refer to the axis in AcroBasic.
static AxisName	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisName[]	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 AxisName AXIS0

AXIS1

public static final AxisName AXIS1

AXIS2

public static final AxisName AXIS2

AXIS3

public static final AxisName AXIS3

AXIS4

public static final AxisName AXIS4

AXIS5

public static final AxisName AXIS5

AXIS6

public static final AxisName AXIS6

AXIS7

public static final AxisName AXIS7

Method Detail

values

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

Returns:

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

valueOf

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

index

public int index()

Gets the motor controller's index number of the axis.

Returns:

the index.

reference

public String reference()

Gets the string used to refer to the axis in AcroBasic.

Returns:

the reference string.