org.lsst.ccs.drivers.parker

Enum EncoderName

java.lang.Object

java.lang.Enum<EncoderName>

org.lsst.ccs.drivers.parker.EncoderName

All Implemented Interfaces:

Serializable, Comparable<EncoderName>

public enum EncoderName
extends Enum<EncoderName>

Defines names for eight out of 16 possible encoders. An encode is attached to one axis in order to provide position or velocity.

Author:

tether

See Also:

AxisName, MasterName

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENC0
ENC1
ENC2
ENC3
ENC4
ENC5
ENC6
ENC7

Method Summary

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

ENC0

public static final EncoderName ENC0

ENC1

public static final EncoderName ENC1

ENC2

public static final EncoderName ENC2

ENC3

public static final EncoderName ENC3

ENC4

public static final EncoderName ENC4

ENC5

public static final EncoderName ENC5

ENC6

public static final EncoderName ENC6

ENC7

public static final EncoderName ENC7

Method Detail

values

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

Returns:

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

valueOf

public static EncoderName 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 encoder.

Returns:

the index.

reference

public String reference()

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

Returns:

the reference string.