Package org.simulator.sbml

Classes for storing and interpreting an SBML model. The most important class is SBMLinterpreter that can return the current vector of derivatives to the solver.

One important special case of during the simulation of SBML models is dealing with Constraint violation. To this end, this package also provides the interface ConstraintListener, which takes a special EventObject, namely the ConstraintEvent as an argument. The method ConstraintListener.processViolation(ConstraintEvent) can then be used to deal with the Constraint. It receives the time, when the Constraint's condition has been violated together with a reference of the Constraint itself. By default, the SBMLinterpreter adds an instance of SimpleConstraintListener to its list of ConstraintListeners. You can remove this element by calling SBMLinterpreter.removeConstraintListener(int) with the argument 0 and add an arbitrary number of user-specific listeners instead. The SimpleConstraintListener uses the standard Java Logger and displays the time, condition (as formula String), and the message of the Constraint on the log-level Level.WARNING. A recommended practice would be maintain a list for each Constraint that gathers all points in time, when it was violated. This list could at the end of the simulation be presented to the user via a graphical user interface together with a rendered version of the message (note that the message element in the Constraint is not a simple text, but an arbitrary XHTML document and therefore not always suitable to be displayed on the console).

Version:

$Rev$

Interface Summary

Interface	Description
ConstraintListener	A listener interface that allows the processing of Constraints that triggered during simulation.
SBMLValueHolder	A SBMLValueHolder is necessary to provide the current values for Compartments, Species, Parameters, and SpeciesReferences at simulation time.

Class Summary

Class	Description
AddMetaInfo	This class contains static methods to add meta information to a model inside SBMLDocument.
AlgebraicRuleConverter	This class converts the algebraic rules of a model to assignment rules based on the given matching.
ConstraintEvent	This class represents the violation of a Constraint during simulation.
SBMLEventInProgress	This class represents a compilation of all information calculated during simulation concerning events in SBML.
SBMLEventInProgressWithDelay	This class represents a compilation of all information calculated during simulation concerning events in SBML.
SBMLinterpreter	This differential equation system (DESystem) takes a model in SBML format and maps it to a data structure that is understood by the AbstractDESSolver.
SimpleConstraintListener	This class represents a simple listener implementation to process the violation of Constraints during simulation by logging the violation event in form of a warning.