org.lsst.ccs.drivers.parker

Enum ProgramBit

java.lang.Object

java.lang.Enum<ProgramBit>

org.lsst.ccs.drivers.parker.ProgramBit

All Implemented Interfaces:

Serializable, Comparable<ProgramBit>

public enum ProgramBit
extends Enum<ProgramBit>

Names and numbers controller bits associated with particular programs.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
PROGRAM_DWELLING When set it indicates that the associated program is dwelling, that is, sleeping for a specific time.
PROGRAM_INHIBITED When set it indicates that the associated program is inhibited, that is, executing an INH command.
PROGRAM_RUNNING When set it indicates that the associated program is running, that is, execution has not terminated.

Method Summary

Modifier and Type	Method and Description
ProgramUnsigned	flagParameter() Gets the enumerator for the flag parameter containing this bit.
long	flagParameterMask() Gets the mask with a single 1 bit in the position assigned to this bit in the associated flag parameter.
int	index(ProgramName program) Gets the motor controller's index for the bit for the given program.
String	reference(ProgramName program) Gets the string used to refer to the bit for the given program in AcroBasic.
static ProgramBit	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgramBit[]	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_RUNNING

public static final ProgramBit PROGRAM_RUNNING

When set it indicates that the associated program is running, that is, execution has not terminated. A program that's dwelling or inhibited is still running.

The ACR binary comm protocol allows setting and clearing bits directly via their bit index numbers, but for some reason the only way you can get the value of a bit is to read the corresponding flag parameter word and examine the right bit.

PROGRAM_DWELLING

public static final ProgramBit PROGRAM_DWELLING

When set it indicates that the associated program is dwelling, that is, sleeping for a specific time.

PROGRAM_INHIBITED

public static final ProgramBit PROGRAM_INHIBITED

When set it indicates that the associated program is inhibited, that is, executing an INH command.

Method Detail

values

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

Returns:

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

valueOf

public static ProgramBit 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 motor controller's index for the bit for the given program.

Parameters:

program - the program.

Returns:

the index.

reference

public String reference(ProgramName program)

Gets the string used to refer to the bit for the given program in AcroBasic.

Parameters:

program - the program.

Returns:

the reference string.

flagParameter

public ProgramUnsigned flagParameter()

Gets the enumerator for the flag parameter containing this bit.

Returns:

the enumerator.

flagParameterMask

public long flagParameterMask()

Gets the mask with a single 1 bit in the position assigned to this bit in the associated flag parameter.

Returns:

the mask.