Package heronarts.lx.parameter

Class FixedParameter

java.lang.Object

heronarts.lx.parameter.FixedParameter

All Implemented Interfaces:

LXPath, LXParameter

public class FixedParameter
extends Object
implements LXParameter

A FixedParameter is an immutable parameter. It will throw a RuntimeException if setValue() is attempted. Useful for anonymous placeholder values in places that expect to use LXParameters.

Nested Class Summary

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
FixedParameter(double value)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when the parameter is done being used and none of its resources are needed anymore.
String	getDescription()	Returns a contextual help message explaining the purpose of this parameter or component to the user, or null if none is available.
LXParameter.Formatter	getFormatter()	Gets the formatter to be used for printing this parameter's value
String	getLabel()	Gets the label for this parameter
LXComponent	getParent()	Returns the component that this object belongs to
String	getPath()	Returns the immediate path of this component, relative to its parent
LXParameter.Polarity	getPolarity()	Gets the polarity of this parameter.
LXParameter.Units	getUnits()	Gets the unit format that this parameter's value stores.
double	getValue()	Retrieves the value of the parameter
LXParameter	reset()	A method to reset the value of the parameter, if a default is available.
LXParameter	setComponent(LXComponent parent, String path)	Sets the component that owns this parameter
FixedParameter	setFormatter(LXParameter.Formatter formatter)	Sets the formatter used for printing this parameter's value
LXParameter	setValue(double value)	Sets the value of the parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface heronarts.lx.parameter.LXParameter

getBaseValue, getBaseValuef, getParentParameter, getValuef, isMappable, setMappable

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Constructor Details

FixedParameter

public FixedParameter(double value)

Method Details

getDescription

public String getDescription()

Description copied from interface: LXPath

Returns a contextual help message explaining the purpose of this parameter or component to the user, or null if none is available.

Specified by:

getDescription in interface LXPath

Returns:

Contextual help string explaining purpose of the element

setComponent

public LXParameter setComponent(LXComponent parent,
 String path)

Description copied from interface: LXParameter

Sets the component that owns this parameter

Specified by:

setComponent in interface LXParameter

Parameters:

parent - Component

path - Path name for parameter

Returns:

this

getParent

public LXComponent getParent()

Description copied from interface: LXPath

Returns the component that this object belongs to

Specified by:

getParent in interface LXPath

Returns:

Parent component of this path object, or null if it is unowned

getPath

public String getPath()

Description copied from interface: LXPath

Returns the immediate path of this component, relative to its parent

Specified by:

getPath in interface LXPath

Returns:

Path of this object relative to its parent component

getFormatter

public LXParameter.Formatter getFormatter()

Description copied from interface: LXParameter

Gets the formatter to be used for printing this parameter's value

Specified by:

getFormatter in interface LXParameter

Returns:

Formatter

setFormatter

public FixedParameter setFormatter(LXParameter.Formatter formatter)

Description copied from interface: LXParameter

Sets the formatter used for printing this parameter's value

Specified by:

setFormatter in interface LXParameter

Parameters:

formatter - Formatter

Returns:

The parameter

getUnits

public LXParameter.Units getUnits()

Description copied from interface: LXParameter

Gets the unit format that this parameter's value stores.

Specified by:

getUnits in interface LXParameter

Returns:

Units

getPolarity

public LXParameter.Polarity getPolarity()

Description copied from interface: LXParameter

Gets the polarity of this parameter.

Specified by:

getPolarity in interface LXParameter

Returns:

polarity of this parameter

dispose

public void dispose()

Description copied from interface: LXParameter

Invoked when the parameter is done being used and none of its resources are needed anymore.

Specified by:

dispose in interface LXParameter

reset

public LXParameter reset()

Description copied from interface: LXParameter

A method to reset the value of the parameter, if a default is available. Not necessarily defined for all parameters, may be ignored.

Specified by:

reset in interface LXParameter

Returns:

this

setValue

public LXParameter setValue(double value)

Description copied from interface: LXParameter

Sets the value of the parameter.

Specified by:

setValue in interface LXParameter

Parameters:

value - The value

Returns:

this

getValue

public double getValue()

Description copied from interface: LXParameter

Retrieves the value of the parameter

Specified by:

getValue in interface LXParameter

Returns:

Parameter value

getLabel

public String getLabel()

Description copied from interface: LXParameter

Gets the label for this parameter

Specified by:

getLabel in interface LXParameter

Specified by:

getLabel in interface LXPath

Returns:

Label of parameter