org.lsst.ccs.drivers.lighthouse

Enum RecordFlag

java.lang.Object

java.lang.Enum<RecordFlag>

org.lsst.ccs.drivers.lighthouse.RecordFlag

All Implemented Interfaces:

Serializable, Comparable<RecordFlag>

public enum RecordFlag
extends Enum<RecordFlag>

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

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOW_RATE Couldn't get a normal air flow rate.
HIGH The reading is above the upper threshold.
LASER Laser problem.
LOW The reading is below the lower threshold.
MALFUNCTION Instrument malfunction.
OK No problems.
OVERFLOW Counter overflow.
SAMPLER Sampler problem.

Method Summary

Modifier and Type	Method and Description
static Set<RecordFlag>	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 RecordFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordFlag[]	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

OK

public static final RecordFlag OK

No problems.

LASER

public static final RecordFlag LASER

Laser problem.

FLOW_RATE

public static final RecordFlag FLOW_RATE

Couldn't get a normal air flow rate.

OVERFLOW

public static final RecordFlag OVERFLOW

Counter overflow.

MALFUNCTION

public static final RecordFlag MALFUNCTION

Instrument malfunction.

HIGH

public static final RecordFlag HIGH

The reading is above the upper threshold.

LOW

public static final RecordFlag LOW

The reading is below the lower threshold.

SAMPLER

public static final RecordFlag SAMPLER

Sampler problem.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

The text.

getMask

public int getMask()

Gets the hardware mask value for the flag.

Returns:

The mask.

flagsFromMask

public static Set<RecordFlag> 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. Contains OK if nothing else matches.