org.lsst.ccs.drivers.parker

Enum MasterBit

java.lang.Object

java.lang.Enum<MasterBit>

org.lsst.ccs.drivers.parker.MasterBit

All Implemented Interfaces:

Serializable, Comparable<MasterBit>

public enum MasterBit
extends Enum<MasterBit>

Names and numbers controller bits associated with particular masters.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILL_ALL_MOVES When set stops all the master's motion immediately, ignoring any programmed end-of-motion deceleration.

Method Summary

Modifier and Type	Method and Description
MasterUnsigned	flagParameter() Gets 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(MasterName master) Gets the motor controller's index for the bit for the given master.
String	reference(MasterName master) Gets the string used to refer to the bit for the given master in AcroBasic.
static MasterBit	valueOf(String name) Returns the enum constant of this type with the specified name.
static MasterBit[]	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

KILL_ALL_MOVES

public static final MasterBit KILL_ALL_MOVES

When set stops all the master's motion immediately, ignoring any programmed end-of-motion deceleration. Motion commands for that master will be ignored until this bit is cleared. First clear this bit then the KILL_ALL_MOTION bits in the slave axes.

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.

Method Detail

values

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

Returns:

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

valueOf

public static MasterBit 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(MasterName master)

Gets the motor controller's index for the bit for the given master.

Parameters:

master - the master.

Returns:

the index.

reference

public String reference(MasterName master)

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

Parameters:

master - the master.

Returns:

the reference string.

flagParameter

public MasterUnsigned flagParameter()

Gets 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.