bio.singa.simulation.model.rules

Class AppliedExpression

java.lang.Object

bio.singa.simulation.model.rules.AppliedExpression

public class AppliedExpression
extends Object

Applied expressions encapsulate formulas in given in String form. Additionally SimulationParameters need to be defined that are substituted into the expression and resolved for their values.

Author:

cl

Constructor Summary

Constructors

Constructor and Description
AppliedExpression(String expression, javax.measure.Unit<?> resultUnit) Creates an expression from the given string.

Method Summary

Modifier and Type	Method and Description
void	acceptValue(String parameter, double value) Replaces a value for the parameter with the given identifier.
javax.measure.Quantity<?>	evaluate() Evaluates the expression and returns the result.
String	getExpressionString() Returns the expression string.
Map<String,SimulationParameter>	getParameters() Returns the parameters of the expression.
void	setParameter(SimulationParameter parameter) Sets a parameter of the expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppliedExpression

public AppliedExpression(String expression,
                         javax.measure.Unit<?> resultUnit)

Creates an expression from the given string.

Parameters:

expression - The string that is converted into the expression;

resultUnit - The unit resulting from the calculation.

Method Detail

getParameters

public Map<String,SimulationParameter> getParameters()

Returns the parameters of the expression.

Returns:

The parameters of the expression.

setParameter

public void setParameter(SimulationParameter parameter)

Sets a parameter of the expression.

Parameters:

parameter - A parameter that is substituted into the expression

getExpressionString

public String getExpressionString()

Returns the expression string.

Returns:

The expression string.

acceptValue

public void acceptValue(String parameter,
                        double value)

Replaces a value for the parameter with the given identifier. The parameter needs to be set first.

Parameters:

parameter - The parameter to set.

value - The new value of the parameter.

evaluate

public javax.measure.Quantity<?> evaluate()

Evaluates the expression and returns the result. If not all parameters have been set or the expression evaluates to NaN an error is logged.

Returns:

The result of the evaluated expression.