org.lsst.ccs.drivers.parker

Enum ProgramName

java.lang.Object

java.lang.Enum<ProgramName>

org.lsst.ccs.drivers.parker.ProgramName

All Implemented Interfaces:

Serializable, Comparable<ProgramName>

public enum ProgramName
extends Enum<ProgramName>

Defines names for eight of the possible 16 AcroBasic programs. Use ordinal() to get the index number used by the motor controller and use name() to get the string used in AcroBasic commands.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
PROG0
PROG1
PROG2
PROG3
PROG4
PROG5
PROG6
PROG7

Method Summary

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

PROG0

public static final ProgramName PROG0

PROG1

public static final ProgramName PROG1

PROG2

public static final ProgramName PROG2

PROG3

public static final ProgramName PROG3

PROG4

public static final ProgramName PROG4

PROG5

public static final ProgramName PROG5

PROG6

public static final ProgramName PROG6

PROG7

public static final ProgramName PROG7

Method Detail

values

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

Returns:

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

valueOf

public static ProgramName 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 program.

Returns:

the index.

reference

public String reference()

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

Returns:

the reference string.