Package org.simulator.sbml.astnode

Class AssignmentRuleValue

java.lang.Object

org.simulator.sbml.astnode.RuleValue

org.simulator.sbml.astnode.AssignmentRuleValue

public class AssignmentRuleValue
extends RuleValue

This class can compute and store the value of an AssignmentRule together with the variable of the rule.

Version:

$Rev$

Author:

Roland Keller

Field Summary

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

compartmentIndex, hasOnlySubstanceUnits, hasZeroSpatialDimensions, index, isSetInitialAmount, isSetInitialConcentration, isSpecies, nodeObject, value, valueHolder

Constructor Summary

Constructors

Constructor	Description
AssignmentRuleValue(ASTNodeValue nodeObject, int index)
AssignmentRuleValue(ASTNodeValue nodeObject, int index, org.sbml.jsbml.Species sp, int compartmentIndex, boolean hasZeroSpatialDimensions, SBMLValueHolder valueHolder)	Constructor for rules that refer to a species
AssignmentRuleValue(ASTNodeValue nodeObject, String speciesReferenceID, Map<String,Double> stoichiometricCoefHash)	Constructor for rules that refer to a species reference

Method Summary

Modifier and Type	Method	Description
org.sbml.jsbml.ASTNode	getMath()
String	getSpeciesReferenceID()	Returns the id of the species reference (if present), null otherwise.
boolean	processRule(double[] Y, double time, boolean changeY)	Processes the rule and saves the new value of the corresponding variable in the Y vector if changeY is set to true.

Methods inherited from class java.lang.Object

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

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

getIndex, getValue, processAssignmentVariable

Constructor Detail

AssignmentRuleValue

public AssignmentRuleValue(ASTNodeValue nodeObject,
                           int index)

Parameters:

nodeObject -

index -

AssignmentRuleValue

public AssignmentRuleValue(ASTNodeValue nodeObject,
                           String speciesReferenceID,
                           Map<String,Double> stoichiometricCoefHash)

Constructor for rules that refer to a species reference

Parameters:

nodeObject -

speciesReferenceID -

stoichiometricCoefHash -

AssignmentRuleValue

public AssignmentRuleValue(ASTNodeValue nodeObject,
                           int index,
                           org.sbml.jsbml.Species sp,
                           int compartmentIndex,
                           boolean hasZeroSpatialDimensions,
                           SBMLValueHolder valueHolder)

Constructor for rules that refer to a species

Parameters:

nodeObject -

index -

sp -

compartmentIndex -

hasZeroSpatialDimensions -

valueHolder -

Method Detail

processRule

public boolean processRule(double[] Y,
                           double time,
                           boolean changeY)

Processes the rule and saves the new value of the corresponding variable in the Y vector if changeY is set to true.

Parameters:

Y -

time -

changeY -

Returns:

Has there been a change in the Y vector caused by the rule?

getSpeciesReferenceID

public String getSpeciesReferenceID()

Returns the id of the species reference (if present), null otherwise.

Returns:

id

getMath

public org.sbml.jsbml.ASTNode getMath()