Simulation Core Library

org.simulator.sbml
Interface SBMLValueHolder

All Superinterfaces:
DelayValueHolder, Serializable
All Known Implementing Classes:
SBMLinterpreter

public interface SBMLValueHolder
extends DelayValueHolder, Serializable

A SBMLValueHolder is necessary to provide the current values for Compartments, Species, Parameters, and SpeciesReferences at simulation time. It also grants access to the current simulation time. In this way, it is possible to separate the interpretation and simulation of a Model from the pure evaluation of ASTNodes.

Since:
0.9
Version:
$Rev: 454 $
Author:
Andreas Dräger, Roland Keller

Method Summary
 double getCurrentCompartmentSize(String id)
          Returns the size of the compartment with the given id.
 double getCurrentCompartmentValueOf(String speciesId)
          Returns the size of the compartment of the species with the given id.
 double getCurrentParameterValue(String id)
          Returns the value of the parameter with the given id.
 double getCurrentSpeciesValue(String id)
          Returns the value of the species with the given id.
 double getCurrentStoichiometry(String id)
          Returns the value of the stoichiometry of the species reference with the given id.
 double getCurrentTime()
          Returns the current simulation time.
 double getCurrentValueOf(int position)
          Returns the current value of the Y vector at the given position.
 double getCurrentValueOf(String id)
          Returns the current value of the SBase with the given id.
 
Methods inherited from interface org.simulator.math.odes.DelayValueHolder
computeDelayedValue
 

Method Detail

getCurrentCompartmentSize

double getCurrentCompartmentSize(String id)
Returns the size of the compartment with the given id.

Parameters:
id -
Returns:
compartmentSize

getCurrentCompartmentValueOf

double getCurrentCompartmentValueOf(String speciesId)
Returns the size of the compartment of the species with the given id.

Parameters:
speciesId -
Returns:
compartmentValue

getCurrentParameterValue

double getCurrentParameterValue(String id)
Returns the value of the parameter with the given id.

Parameters:
id -
Returns:
parameterValue

getCurrentSpeciesValue

double getCurrentSpeciesValue(String id)
Returns the value of the species with the given id.

Parameters:
id -
Returns:
speciesValue

getCurrentStoichiometry

double getCurrentStoichiometry(String id)
Returns the value of the stoichiometry of the species reference with the given id.

Parameters:
id -
Returns:
stoichiometry

getCurrentTime

double getCurrentTime()
Returns the current simulation time.

Returns:
time

getCurrentValueOf

double getCurrentValueOf(String id)
Returns the current value of the SBase with the given id.

Parameters:
id -
Returns:
value

getCurrentValueOf

double getCurrentValueOf(int position)
Returns the current value of the Y vector at the given position.

Parameters:
position -
Returns:
value

Generated at March 17 2014
Version 1.4 Revision 453