org.simulator.sbml.astnode

Class RateRuleValue

java.lang.Object

org.simulator.sbml.astnode.RuleValue

org.simulator.sbml.astnode.RateRuleValue

public class RateRuleValue
extends RuleValue

This class can compute and store the value of a rate rule together with the variable of the rule.

Version:

$Rev$

Author:

Roland Keller

Constructor Summary

Constructors

Constructor and Description
RateRuleValue(ASTNodeValue nodeObject, int index, List<Integer> speciesIndices, SBMLValueHolder valueHolder, String variable) Constructor for a rule with a compartment as variable
RateRuleValue(ASTNodeValue nodeObject, int index, org.sbml.jsbml.Species sp, int compartmentIndex, boolean hasZeroSpatialDimensions, SBMLValueHolder valueHolder, String variable, boolean isAmount) Constructor for a rule with a species as variable
RateRuleValue(ASTNodeValue nodeObject, int index, String variable)

Method Summary

Modifier and Type	Method and Description
String	getVariable()
void	processRule(double[] changeRate, double[] Y, double time) Processes the rule and saves the new value of the corresponding variable in the changeRate vector.
void	setCompartmentRateRule(RateRuleValue compartmentRateRule)

Methods inherited from class org.simulator.sbml.astnode.RuleValue

getIndex, getNodeObject, getValue

Methods inherited from class java.lang.Object

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

Constructor Detail

RateRuleValue

public RateRuleValue(ASTNodeValue nodeObject,
                     int index,
                     String variable)

Parameters:

nodeObject -

index -

RateRuleValue

public RateRuleValue(ASTNodeValue nodeObject,
                     int index,
                     org.sbml.jsbml.Species sp,
                     int compartmentIndex,
                     boolean hasZeroSpatialDimensions,
                     SBMLValueHolder valueHolder,
                     String variable,
                     boolean isAmount)

Constructor for a rule with a species as variable

Parameters:

nodeObject -

index -

sp -

compartmentIndex -

hasZeroSpatialDimensions -

valueHolder -

variable -

isAmount -

RateRuleValue

public RateRuleValue(ASTNodeValue nodeObject,
                     int index,
                     List<Integer> speciesIndices,
                     SBMLValueHolder valueHolder,
                     String variable)

Constructor for a rule with a compartment as variable

Parameters:

nodeObject -

index -

speciesIndices -

valueHolder -

Method Detail

getVariable

public String getVariable()

Returns:

the name of the variable

processRule

public void processRule(double[] changeRate,
                        double[] Y,
                        double time)

Processes the rule and saves the new value of the corresponding variable in the changeRate vector.

Parameters:

changeRate -

Y -

time -

setCompartmentRateRule

public void setCompartmentRateRule(RateRuleValue compartmentRateRule)