org.lsst.ccs.drivers.parker

Enum AxisLong

java.lang.Object

java.lang.Enum<AxisLong>

org.lsst.ccs.drivers.parker.AxisLong

All Implemented Interfaces:

Serializable, Comparable<AxisLong>

public enum AxisLong
extends Enum<AxisLong>

Defines names and numbers for axis parameters that are signed LONGs.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
HARDWARE_CAPTURE Hardware position, in counts, captured using the INTCAP command.
PRIMARY_SETPOINT Where we're supposed to be, in encoder counts or stepper counts.
SOFTWARE_CAPTURE Hardware position, in counts, captured by setting the Trigger Software Capture bit.

Method Summary

Modifier and Type	Method and Description
int	index(AxisName axis) Gets the controller's index for this parameter for a given axis.
String	reference(AxisName axis) Gets the AcroBasic string reference for this parameter for a given axis.
static AxisLong	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisLong[]	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

HARDWARE_CAPTURE

public static final AxisLong HARDWARE_CAPTURE

Hardware position, in counts, captured using the INTCAP command. Normally this requires an encoder but the INTCAP command description tells how to use it for stepper motors with no encoders.

SOFTWARE_CAPTURE

public static final AxisLong SOFTWARE_CAPTURE

Hardware position, in counts, captured by setting the Trigger Software Capture bit. Normally this requires an encoder but the INTCAP command description tells how to use it for stepper motors with no encoders.

PRIMARY_SETPOINT

public static final AxisLong PRIMARY_SETPOINT

Where we're supposed to be, in encoder counts or stepper counts. Use the PPU setting to convert this to a coordinate. This value is the sum of Current Position, Gear Offset, Jog Offset, Cam Offset, Ballscrew Offset and Backlash Offset.

Method Detail

values

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

Returns:

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

valueOf

public static AxisLong 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(AxisName axis)

Gets the controller's index for this parameter for a given axis.

Parameters:

axis - the axis.

Returns:

the index.

reference

public String reference(AxisName axis)

Gets the AcroBasic string reference for this parameter for a given axis.

Parameters:

axis - the axis.

Returns:

the reference string.