org.lsst.ccs.drivers.lighthouse

Enum ChannelUnits

java.lang.Object

java.lang.Enum<ChannelUnits>

org.lsst.ccs.drivers.lighthouse.ChannelUnits

All Implemented Interfaces:

Serializable, Comparable<ChannelUnits>

public enum ChannelUnits
extends Enum<ChannelUnits>

The measurement units for Lighthouse data channels. Not an exhaustive list by any means.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
CELSIUS A temperature on the Celsius scale.
COUNTS A count of particles of a certain size.
FAHRENHEIT A temperature on the Fahrenheit scale.
PERCENTAGE A percentage, for example relative humidity.

Method Summary

Modifier and Type	Method and Description
static ChannelUnits	fromUnitsLabel(String label) Find the measurement type corresponding to a device units-label.
String	getDeviceText() Gets the string used by the device to represent these units.
String	toString() Gets the string used to represent these units in files or other external storage.
static ChannelUnits	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChannelUnits[]	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

COUNTS

public static final ChannelUnits COUNTS

A count of particles of a certain size.

PERCENTAGE

public static final ChannelUnits PERCENTAGE

A percentage, for example relative humidity.

CELSIUS

public static final ChannelUnits CELSIUS

A temperature on the Celsius scale.

FAHRENHEIT

public static final ChannelUnits FAHRENHEIT

A temperature on the Fahrenheit scale.

Method Detail

values

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

Returns:

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

valueOf

public static ChannelUnits 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 string used to represent these units in files or other external storage.

Overrides:

toString in class Enum<ChannelUnits>

Returns:

The string.

getDeviceText

public String getDeviceText()

Gets the string used by the device to represent these units.

Returns:

The string.

fromUnitsLabel

public static ChannelUnits fromUnitsLabel(String label)

Find the measurement type corresponding to a device units-label.

Parameters:

label - The data units label used by the counter.

Returns:

The corresponding ChannelUnits enumerator.