Package de.unirostock.sems.bives.cellml.parser

Class CellMLReactionSubstance.Role

java.lang.Object

de.unirostock.sems.bives.cellml.parser.CellMLEntity

de.unirostock.sems.bives.cellml.parser.CellMLReactionSubstance.Role

Enclosing class:

CellMLReactionSubstance

public class CellMLReactionSubstance.Role
extends CellMLEntity

The Class Role.

Field Summary

Fields

Modifier and Type	Field	Description
CellMLVariable	delta_variable	The optional delta_variable attribute indicates which variable is used to store the change in concentration of the species represented by the variable referenced by the current variable_ref element.
int	direction	The optional direction attribute may be used on role elements in reversible reactions.
List<de.unirostock.sems.bives.ds.MathML>	math	The role elements may also contain math elements in the MathML namespace, which define equations using MathML.
int	role	The role attribute must have a value of "reactant", "product", "catalyst", "activator", "inhibitor", "modifier", or "rate".
Double	stoichiometry	The optional stoichiometry attribute stores the stoichiometry of the current variable relative to the other reaction participants.

Fields inherited from class de.unirostock.sems.bives.cellml.parser.CellMLEntity

model

Constructor Summary

Constructors

Constructor	Description
Role(CellMLModel model, de.unirostock.sems.xmlutils.ds.DocumentNode node)	Instantiates a new role.

Method Summary

Methods inherited from class de.unirostock.sems.bives.cellml.parser.CellMLEntity

associateRdfDescription, flagMetaModifcations, getDocumentNode, getMetaId, getModel, getRdfBlocks, getRdfDescriptions, setMetaId, setModel

Methods inherited from class java.lang.Object

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

Field Detail

role

public int role

The role attribute must have a value of "reactant", "product", "catalyst", "activator", "inhibitor", "modifier", or "rate".

direction

public int direction

The optional direction attribute may be used on role elements in reversible reactions. If defined, it must have a value of "forward", "reverse", or "both". Its value indicates the direction of the reaction for which the role is relevant. It has a default value of "forward".

delta_variable

public CellMLVariable delta_variable

The optional delta_variable attribute indicates which variable is used to store the change in concentration of the species represented by the variable referenced by the current variable_ref element.

stoichiometry

public Double stoichiometry

The optional stoichiometry attribute stores the stoichiometry of the current variable relative to the other reaction participants.

math

public List<de.unirostock.sems.bives.ds.MathML> math

The role elements may also contain math elements in the MathML namespace, which define equations using MathML.

Constructor Detail

Role

public Role(CellMLModel model,
            de.unirostock.sems.xmlutils.ds.DocumentNode node)
     throws BivesCellMLParseException,
            de.unirostock.sems.bives.exception.BivesDocumentConsistencyException,
            de.unirostock.sems.bives.exception.BivesLogicalException

Instantiates a new role.

Parameters:

model - the model that contains this reaction

node - the corresponding document node in the XML tree

Throws:

BivesCellMLParseException - the bives cell ml parse exception

de.unirostock.sems.bives.exception.BivesDocumentConsistencyException - the bives document consistency exception

de.unirostock.sems.bives.exception.BivesLogicalException - the bives logical exception