agentgui.math.calculation

Class CalcParameter

java.lang.Object

agentgui.math.calculation.CalcExpression

agentgui.math.calculation.CalcParameter

All Implemented Interfaces:

java.io.Serializable

public class CalcParameter
extends CalcExpression

The Class CalcParameter can bes used in order to set a Parameter for a formula. Possible CalcExpression Types can be CalcConstant and CalcFormula

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalcParameter.ExpressionType The Enumeration ExpressionType provides a selection of possible parameters that can be set.

Constructor Summary

Constructors

Constructor and Description
CalcParameter() Instantiates a new parameter for calculations.
CalcParameter(CalcParameter.ExpressionType expressionType, CalcExpression calcExpression) Instantiates a new parameter for calculations.

Method Summary

Modifier and Type	Method and Description
CalcExpression	getCalcExpression() Gets the current CalcExpression.
CalcParameter.ExpressionType	getExpressionType() Returns the current ExpressionType.
double	getValue() Returns or calculates the value of the CalcExpression.
void	setCalcExpression(CalcExpression calcExpression) Sets the current CalcExpression which can be either a constant value or a formula, which has to be calculated.
void	setExpressionType(CalcParameter.ExpressionType expressionType) Sets the current ExpressionType.

Methods inherited from class agentgui.math.calculation.CalcExpression

getUnit, setUnit, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CalcParameter

public CalcParameter()

Instantiates a new parameter for calculations.

CalcParameter

public CalcParameter(CalcParameter.ExpressionType expressionType,
                     CalcExpression calcExpression)

Instantiates a new parameter for calculations.

Parameters:

expressionType - the parameter type

calcExpression - the CalcExpression

Method Detail

setExpressionType

public void setExpressionType(CalcParameter.ExpressionType expressionType)

Sets the current ExpressionType.

Parameters:

expressionType - the current ExpressionType to set

getExpressionType

public CalcParameter.ExpressionType getExpressionType()

Returns the current ExpressionType.

Returns:

the current ExpressionType

setCalcExpression

public void setCalcExpression(CalcExpression calcExpression)

Sets the current CalcExpression which can be either a constant value or a formula, which has to be calculated.

Parameters:

calcExpression - the calcExpression to set

getCalcExpression

public CalcExpression getCalcExpression()

Gets the current CalcExpression.

Returns:

the calcExpression

getValue

public double getValue()
                throws CalcExeption

Description copied from class: CalcExpression

Returns or calculates the value of the CalcExpression.

Specified by:

getValue in class CalcExpression

Returns:

the value

Throws:

CalcExeption - the CalcExeption