Package heronarts.lx.parameter

Enum Class LXParameter.Units

java.lang.Object

java.lang.Enum<LXParameter.Units>

heronarts.lx.parameter.LXParameter.Units

All Implemented Interfaces:

LXParameter.Formatter, Serializable, Comparable<LXParameter.Units>, Constable

Enclosing interface:

LXParameter

public static enum LXParameter.Units
extends Enum<LXParameter.Units>
implements LXParameter.Formatter

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOCK
DECIBELS
DEGREES
HERTZ
INTEGER
MIDI_NOTE
MILLISECONDS
MILLISECONDS_RAW
NONE
PERCENT
PERCENT_NORMALIZED
RADIANS
SECONDS

Field Summary

Fields inherited from interface heronarts.lx.parameter.LXParameter.Formatter

DECIMAL_MAX_2_PLACES

Method Summary

Modifier and Type	Method	Description
String	format(double value)	Convert a double parameter value into a presentable String
double	parseDouble(String value)
static LXParameter.Units	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LXParameter.Units[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final LXParameter.Units NONE

INTEGER

public static final LXParameter.Units INTEGER

SECONDS

public static final LXParameter.Units SECONDS

MILLISECONDS

public static final LXParameter.Units MILLISECONDS

MILLISECONDS_RAW

public static final LXParameter.Units MILLISECONDS_RAW

DECIBELS

public static final LXParameter.Units DECIBELS

HERTZ

public static final LXParameter.Units HERTZ

MIDI_NOTE

public static final LXParameter.Units MIDI_NOTE

DEGREES

public static final LXParameter.Units DEGREES

RADIANS

public static final LXParameter.Units RADIANS

PERCENT

public static final LXParameter.Units PERCENT

PERCENT_NORMALIZED

public static final LXParameter.Units PERCENT_NORMALIZED

CLOCK

public static final LXParameter.Units CLOCK

Method Details

values

public static LXParameter.Units[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LXParameter.Units valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

format

public String format(double value)

Description copied from interface: LXParameter.Formatter

Convert a double parameter value into a presentable String

Specified by:

format in interface LXParameter.Formatter

Parameters:

value - Parameter value

Returns:

String for display

parseDouble

public double parseDouble(String value)
                   throws NumberFormatException

Throws:

NumberFormatException