org.lsst.ccs.drivers.lighthouse

Enum DeviceFlag

java.lang.Object

java.lang.Enum<DeviceFlag>

org.lsst.ccs.drivers.lighthouse.DeviceFlag

All Implemented Interfaces:

Serializable, Comparable<DeviceFlag>

public enum DeviceFlag
extends Enum<DeviceFlag>

The status flags that can be set for a Lighthouse counter device.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR There's a problem.
NEW_DATA New data has been collected since the last time the data registers were read.
RUNNING The counter is running, that is, is not stopped.
SAMPLING The counter is running and taking a sample right now.

Method Summary

Modifier and Type	Method and Description
static Set<DeviceFlag>	flagsFromMask(int mask) Calculates the set of flags whose bits are set in a given mask.
int	getMask() Gets the hardware mask value for the flag.
String	toString() Gets the text form of the flag.
static DeviceFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceFlag[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RUNNING

public static final DeviceFlag RUNNING

The counter is running, that is, is not stopped.

SAMPLING

public static final DeviceFlag SAMPLING

The counter is running and taking a sample right now.

NEW_DATA

public static final DeviceFlag NEW_DATA

New data has been collected since the last time the data registers were read.

ERROR

public static final DeviceFlag ERROR

There's a problem.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Gets the text form of the flag.

Overrides:

toString in class Enum<DeviceFlag>

Returns:

The text.

getMask

public int getMask()

Gets the hardware mask value for the flag.

Returns:

The mask.

flagsFromMask

public static Set<DeviceFlag> flagsFromMask(int mask)

Calculates the set of flags whose bits are set in a given mask.

Parameters:

mask - The channel status bits from the counter.

Returns:

The read-only set of flags corresponding to the mask. C