heronarts.lx.parameter

Class FunctionalParameter

java.lang.Object

heronarts.lx.parameter.FunctionalParameter

All Implemented Interfaces:

LXPath, LXParameter

Direct Known Subclasses:

BoundedFunctionalParameter

public abstract class FunctionalParameter
extends Object
implements LXParameter

An LXParameter that has a value computed by a function, which may combine the values of other parameters, or call some function, etc.

Nested Class Summary

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

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FunctionalParameter()
protected	FunctionalParameter(String label)

Method Summary

Modifier and Type	Method and 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 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.
abstract double	getValue() Retrieves the value of the parameter, subclass must implement.
float	getValuef() Utility helper function to get the value of the parameter as a float.
FunctionalParameter	reset() Does nothing, subclass may override.
LXParameter	setComponent(LXComponent parent, String path) Sets the component that owns this parameter
FunctionalParameter	setDescription(String description)
LXParameter	setValue(double value) Not supported for this parameter type unless subclass overrides.

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

isMappable, setMappable

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

description

protected String description

Constructor Detail

FunctionalParameter

protected FunctionalParameter()

FunctionalParameter

protected FunctionalParameter(String label)

Method Detail

getDescription

public String getDescription()

Description copied from interface: LXParameter

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

Specified by:

getDescription in interface LXParameter

Returns:

Contextual help string explaining purpose of parameter.

setDescription

public FunctionalParameter setDescription(String description)

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

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

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

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

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 FunctionalParameter reset()

Does nothing, subclass may override.

Specified by:

reset in interface LXParameter

Returns:

this

setValue

public LXParameter setValue(double value)

Not supported for this parameter type unless subclass overrides.

Specified by:

setValue in interface LXParameter

Parameters:

value - The value

Returns:

this

getValue

public abstract double getValue()

Retrieves the value of the parameter, subclass must implement.

Specified by:

getValue in interface LXParameter

Returns:

Parameter value

getValuef

public float getValuef()

Utility helper function to get the value of the parameter as a float.

Specified by:

getValuef in interface LXParameter

Returns:

Parameter value as float

getLabel

public final String getLabel()

Gets the label for this parameter

Specified by:

getLabel in interface LXPath

Specified by:

getLabel in interface LXParameter

Returns:

Label of parameter