org.lsst.ccs.drivers.parker

Enum ProgramUnsigned

java.lang.Object

java.lang.Enum<ProgramUnsigned>

org.lsst.ccs.drivers.parker.ProgramUnsigned

All Implemented Interfaces:

Serializable, Comparable<ProgramUnsigned>

public enum ProgramUnsigned
extends Enum<ProgramUnsigned>

Names and numbers the unsigned long controller parameters associated with particular programs.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
PROGRAM_FLAGS Reflects the current state of program execution.
PROGRAM_LINE_NUMBER The line number of the current line being executed or the last line that was executed before the program stopped.

Method Summary

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

PROGRAM_FLAGS

public static final ProgramUnsigned PROGRAM_FLAGS

Reflects the current state of program execution.

PROGRAM_LINE_NUMBER

public static final ProgramUnsigned PROGRAM_LINE_NUMBER

The line number of the current line being executed or the last line that was executed before the program stopped.

Method Detail

values

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

Returns:

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

valueOf

public static ProgramUnsigned 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(ProgramName program)

Gets the controller's index number for the parameter for a given program.

Parameters:

program - the program.

Returns:

the parameter index number.

reference

public String reference(ProgramName program)

Gets the string used to refer to the parameter in AcroBasic, given the program.

Parameters:

program - the program.

Returns:

the reference string.