de.labAlive.core.parameters.parameter

Class Parameter

java.lang.Object

de.labAlive.core.parameters.parameter.DetailLevelParameter

de.labAlive.core.parameters.parameter.Parameter

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

DoubleParameter, IntParameter

public abstract class Parameter
extends DetailLevelParameter
implements java.lang.Cloneable

System or Measure parameter (setting, property), e.g. frequency of a signal generator. The parameter can be edited / adjusted in a Property Window. Implements Cloneable: all subtypes can be cloned as long as they only have primitive data types and immutable objects like String. Use Parameter for extended number formatting with maximumIntegerDigits

Field Summary

Fields

Modifier and Type	Field and Description
Property<?>	handler
MinMaxIncr	minMaxIncr
NumberFormat	numberFormat

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name, java.lang.String baseUnit)

Method Summary

Modifier and Type	Method and Description
Parameter	clone() 5.
double	getAbsolute()
java.lang.String	getDisplayName()
double	getDisplayValue()
java.lang.String	getDisplayValueStr()
double	getDoubleValue()
int	getIntValue()
MinMaxIncr	getMinMaxIncr()
java.lang.String	getName()
int	getScrollIntValue() Helper to transform value into a int representation used for Scrollbars.
java.lang.String	getUnit()
double	getUnitFaktor()
abstract double	getValue()
double	getValue(int scrollValue) Helper to transform int value from Scrollbars into a double representation.
void	processDependencies()
void	setBaseUnit(java.lang.String baseUnit)
void	setDisplayDigits(int digits)
void	setHandler(Parameter parameter)
void	setHandler(Property<?> handler)
void	setMaximumIntegerDigits(int maximumIntegerDigits) 4.
void	setName(java.lang.String name)
abstract void	setValue(double value)
abstract void	setValue(int value)
void	slide(int minValue, int maxValue)
void	slide(MinMaxIncr minMaxIncr)
java.lang.String	toString()
void	updateHandler(Parameters parameters)
void	updateHandlerValue()
void	updateValue(double inputValue) Updates the parameter value according to a value entered in a text field.
void	userChangedThisParameterProcessDependencies(Parameters parameters)
void	userSetsValue(double value)
Parameter	value(double value)
Parameter	value(int value)

Methods inherited from class de.labAlive.core.parameters.parameter.DetailLevelParameter

detailLevel, getDetailLevel, hasUserChangedParameter, resetUserHasChanged, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

numberFormat

public NumberFormat numberFormat

minMaxIncr

public MinMaxIncr minMaxIncr

handler

public Property<?> handler

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String baseUnit)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setBaseUnit

public void setBaseUnit(java.lang.String baseUnit)

getUnit

public java.lang.String getUnit()

getDoubleValue

public double getDoubleValue()

getIntValue

public int getIntValue()

getMinMaxIncr

public MinMaxIncr getMinMaxIncr()

slide

public void slide(MinMaxIncr minMaxIncr)

slide

public void slide(int minValue,
                  int maxValue)

getUnitFaktor

public double getUnitFaktor()

value

public final Parameter value(double value)

value

public final Parameter value(int value)

setValue

public abstract void setValue(double value)

setValue

public abstract void setValue(int value)

getValue

public abstract double getValue()

updateValue

public void updateValue(double inputValue)

Updates the parameter value according to a value entered in a text field. (The unitFaktor must be considered.)

Parameters:

inputValue - the value entered in a text field

userSetsValue

public void userSetsValue(double value)

userChangedThisParameterProcessDependencies

public void userChangedThisParameterProcessDependencies(Parameters parameters)

Overrides:

userChangedThisParameterProcessDependencies in class DetailLevelParameter

getAbsolute

public double getAbsolute()

getDisplayValue

public double getDisplayValue()

Returns:

displayValue = value / unitFaktor

getDisplayValueStr

public java.lang.String getDisplayValueStr()

getScrollIntValue

public int getScrollIntValue()

Helper to transform value into a int representation used for Scrollbars.

Returns:

int representation of the value

getValue

public double getValue(int scrollValue)

Helper to transform int value from Scrollbars into a double representation.

Returns:

int representation of the value

setMaximumIntegerDigits

public void setMaximumIntegerDigits(int maximumIntegerDigits)

4. Helper for Initialization, e.g. SpectrumParameters

setDisplayDigits

public void setDisplayDigits(int digits)

Parameters:

digits - Number of digits for getDisplayValueStr()

clone

public Parameter clone()

5. Internal

Overrides:

clone in class java.lang.Object

setHandler

public void setHandler(Property<?> handler)

setHandler

public void setHandler(Parameter parameter)

updateHandler

public void updateHandler(Parameters parameters)

updateHandlerValue

public void updateHandlerValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

processDependencies

public void processDependencies()