org.lsst.ccs.drivers.lighthouse

Enum DeviceCommand

java.lang.Object

java.lang.Enum<DeviceCommand>

org.lsst.ccs.drivers.lighthouse.DeviceCommand

All Implemented Interfaces:

Serializable, Comparable<DeviceCommand>

public enum DeviceCommand
extends Enum<DeviceCommand>

The hardware commands used by this software. The command number assigned to each enumerator is the actual value written to the device command register. Note that you should stop the device before reading out or clearing its stored records.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLEAR_DATA_BUFFER Delete all stored records and set the record count to zero.
INSTRUMENT_START Start automatic data collection cycles.
INSTRUMENT_STOP Stop automatic data collection.
SET_CLOCK Set the device clock to the contents of the DATA SET registers.

Method Summary

Modifier and Type	Method and Description
int	getCommandNum() Gets the command number.
static DeviceCommand	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceCommand[]	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

CLEAR_DATA_BUFFER

public static final DeviceCommand CLEAR_DATA_BUFFER

Delete all stored records and set the record count to zero.

INSTRUMENT_START

public static final DeviceCommand INSTRUMENT_START

Start automatic data collection cycles.

INSTRUMENT_STOP

public static final DeviceCommand INSTRUMENT_STOP

Stop automatic data collection.

SET_CLOCK

public static final DeviceCommand SET_CLOCK

Set the device clock to the contents of the DATA SET registers.

Method Detail

values

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

Returns:

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

valueOf

public static DeviceCommand 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

getCommandNum

public int getCommandNum()

Gets the command number.

Returns:

The number to write to the device command register in order to execute the command.