hep.aida.ext
Interface IVariable

public interface IVariable

Method Summary

void	addRange(double lower, double upper) Add a new range to the existing range set for the IVariable.
void	connect(IEvaluator ev)
void	connect(ITuple data)
ITuple	connection()
double	error() Get current error of the IVariable.
boolean	isConnected() Check if the IVariable is connected.
boolean	isDependent() Check if the IVariable represents variable or parameter.
boolean	isFixed() Get how the IVariable can be used in fitting.
boolean	isInRange() Check if current value of the IVariable is in the valid range set.
boolean	isInRange(double value) Check if provided value is in the IVariable valid range set.
String	label() Get label for this IVariable.
String	name() Get name for this IVariable.
void	setDependent(boolean state) Set IVariable to represent variable or parameter.
void	setFixed(boolean state) Set how the IVariable can be used in fitting.
void	setRange(double lower, double upper) Set new range for the IVariable.
void	setStep(double step) Set initial step for fitting.
void	setUnits(String units) Set units.
void	setUseBounds(boolean state) Set how fitter should treat bounds for the IVariable.
boolean	setValue(double value) Set value for the IVariable.
String	units() Get units.
boolean	useBounds() Get how fitter should treat bounds for the IVariable.
double	value() Get current value of the IVariable.

Method Detail

label

String label()

Get label for this IVariable.

Returns:

label.

name

String name()

Get name for this IVariable.

Returns:

name.

setValue

boolean setValue(double value)

Set value for the IVariable.

Parameters:

value - Value of IVariable.

Returns:

true if the value was set succesfully, false otherwise, for example if the IVariable is bounded and value is out of range.

value

double value()

Get current value of the IVariable.

Returns:

Current value of the IVariable.

error

double error()

Get current error of the IVariable.

Returns:

Current error of the IVariable.

setRange

void setRange(double lower,
              double upper)

Set new range for the IVariable. All previous ranges are discarded first.

Parameters:

lower - Lower edge of the valid range.

upper - Upper edge of the valid range.

addRange

void addRange(double lower,
              double upper)

Add a new range to the existing range set for the IVariable.

Parameters:

lower - Lower edge of the valid range.

upper - Upper edge of the valid range.

isInRange

boolean isInRange()

Check if current value of the IVariable is in the valid range set.

Returns:

true if current value of the IVariable is in the valid range set.

isInRange

boolean isInRange(double value)

Check if provided value is in the IVariable valid range set.

Parameters:

value - Value to be checked

Returns:

true if provided value is in the IVariable valid range set.

setDependent

void setDependent(boolean state)

Set IVariable to represent variable or parameter.

Parameters:

state - true for variable, false for parameter

isDependent

boolean isDependent()

Check if the IVariable represents variable or parameter.

Returns:

true if this is variable, false if this is parameter

setStep

void setStep(double step)

Set initial step for fitting.

Parameters:

step - Initial step for fitting.

setFixed

void setFixed(boolean state)

Set how the IVariable can be used in fitting.

Parameters:

state - true for fixed parameter, false for variable parameter.

isFixed

boolean isFixed()

Get how the IVariable can be used in fitting.

Returns:

true for fixed parameter, false for variable parameter.

setUseBounds

void setUseBounds(boolean state)

Set how fitter should treat bounds for the IVariable.

Parameters:

state - true use bounds, false don't use bounds.

useBounds

boolean useBounds()

Get how fitter should treat bounds for the IVariable.

Returns:

true use bounds, false don't use bounds.

connect

void connect(ITuple data)

connect

void connect(IEvaluator ev)

isConnected

boolean isConnected()

Check if the IVariable is connected.

Returns:

true if IVariable is connected, false if IVariable is not connected.

connection

ITuple connection()

setUnits

void setUnits(String units)

Set units. Units can be used to annotate plot axis

Parameters:

units - String that describes units

units

String units()

Get units. Units can be used to annotate plot axis

Returns:

String that describes units