org.lsst.ccs.drivers.parker

Enum UserParameter

java.lang.Object

java.lang.Enum<UserParameter>

org.lsst.ccs.drivers.parker.UserParameter

All Implemented Interfaces:

Serializable, Comparable<UserParameter>

public enum UserParameter
extends Enum<UserParameter>

Define names and numbers for some of the global user parameters. Each parameter is a double IEEE float.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
USER0
USER1
USER10
USER11
USER12
USER13
USER14
USER15
USER16
USER17
USER18
USER19
USER2
USER20
USER21
USER22
USER23
USER24
USER25
USER26
USER27
USER28
USER29
USER3
USER30
USER31
USER4
USER5
USER6
USER7
USER8
USER9

Method Summary

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

USER0

public static final UserParameter USER0

USER1

public static final UserParameter USER1

USER2

public static final UserParameter USER2

USER3

public static final UserParameter USER3

USER4

public static final UserParameter USER4

USER5

public static final UserParameter USER5

USER6

public static final UserParameter USER6

USER7

public static final UserParameter USER7

USER8

public static final UserParameter USER8

USER9

public static final UserParameter USER9

USER10

public static final UserParameter USER10

USER11

public static final UserParameter USER11

USER12

public static final UserParameter USER12

USER13

public static final UserParameter USER13

USER14

public static final UserParameter USER14

USER15

public static final UserParameter USER15

USER16

public static final UserParameter USER16

USER17

public static final UserParameter USER17

USER18

public static final UserParameter USER18

USER19

public static final UserParameter USER19

USER20

public static final UserParameter USER20

USER21

public static final UserParameter USER21

USER22

public static final UserParameter USER22

USER23

public static final UserParameter USER23

USER24

public static final UserParameter USER24

USER25

public static final UserParameter USER25

USER26

public static final UserParameter USER26

USER27

public static final UserParameter USER27

USER28

public static final UserParameter USER28

USER29

public static final UserParameter USER29

USER30

public static final UserParameter USER30

USER31

public static final UserParameter USER31

Method Detail

values

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

Returns:

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

valueOf

public static UserParameter 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 parameter index used by the controller.

Returns:

the index.

reference

public String reference()

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

Returns:

the reference string.