agentgui.math.calculation

Class CalcFormula

java.lang.Object

agentgui.math.calculation.CalcExpression

agentgui.math.calculation.CalcFormula

All Implemented Interfaces:

java.io.Serializable

public class CalcFormula
extends CalcExpression

Class for calculations using the JEP Parser.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CalcFormula()

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, CalcExpression expression) This method adds a parameter to the formula's parameter list.
java.lang.String	getFormula() Gets the formula.
java.util.HashMap<java.lang.String,CalcParameter>	getParameters() Gets the parameters.
double	getValue() Returns or calculates the value of the CalcExpression.
void	setFormula(java.lang.String formula) This method sets the formula.
void	setParameters(java.util.HashMap<java.lang.String,CalcParameter> parameters) Sets the parameters.

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

CalcFormula

public CalcFormula()

Method Detail

getFormula

public java.lang.String getFormula()

Gets the formula.

Returns:

the formula

setFormula

public void setFormula(java.lang.String formula)

This method sets the formula.

Parameters:

formula - the formula to set

addParameter

public void addParameter(java.lang.String name,
                         CalcExpression expression)

This method adds a parameter to the formula's parameter list.

Parameters:

name - The parameter name

expression - The parameter value

getParameters

public java.util.HashMap<java.lang.String,CalcParameter> getParameters()

Gets the parameters.

Returns:

the parameters

setParameters

public void setParameters(java.util.HashMap<java.lang.String,CalcParameter> parameters)

Sets the parameters.

Parameters:

parameters - the parameters to set

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