bio.singa.simulation.model.modules.concentration.reactants

Class StoichiometricReactant

java.lang.Object

bio.singa.simulation.model.modules.concentration.reactants.Reactant

bio.singa.simulation.model.modules.concentration.reactants.StoichiometricReactant

public class StoichiometricReactant
extends Reactant

StoichiometricReactants are Reactants that are consumed or produced during the reaction. A StoichiometricReactant can be rate determining and has an associated stoichiometric number and/or reaction order. In Reactions that are not elementary reactions, the reaction order is used to determine the velocity of a reaction. In elementary reactions the stoichiometric number is used to this end.

Constructor Summary

Constructors

Constructor and Description
StoichiometricReactant(ChemicalEntity entity, ReactantRole role) Creates a new StoichiometricReactant.
StoichiometricReactant(ChemicalEntity entity, ReactantRole role, double stoichiometricNumber) Creates a new StoichiometricReactant.
StoichiometricReactant(ChemicalEntity entity, ReactantRole role, double stoichiometricNumber, double reactionOrder) Creates a new StoichiometricReactant.

Method Summary

Modifier and Type	Method and Description
double	getReactionOrder() Returns the reaction order.
double	getStoichiometricNumber() Returns the stoichiometric number (the number of molecules required for one reaction.).
boolean	isProduct() Returns true if this reactant is a product.
boolean	isSubstrate() Returns true if this reactant is a substrate.

Methods inherited from class bio.singa.simulation.model.modules.concentration.reactants.Reactant

getEntity, getRole, setEntity, setRole

Methods inherited from class java.lang.Object

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

Constructor Detail

StoichiometricReactant

public StoichiometricReactant(ChemicalEntity entity,
                              ReactantRole role,
                              double stoichiometricNumber,
                              double reactionOrder)

Creates a new StoichiometricReactant.

Parameters:

entity - The referenced entity.

role - The reactant role.

stoichiometricNumber - The number of molecules required for one reaction.

reactionOrder - The reaction order of the reactant.

StoichiometricReactant

public StoichiometricReactant(ChemicalEntity entity,
                              ReactantRole role,
                              double stoichiometricNumber)

Creates a new StoichiometricReactant. Reaction order is set to 1.

Parameters:

entity - The referenced entity.

role - The reactant role.

stoichiometricNumber - The number of molecules required for one reaction.

StoichiometricReactant

public StoichiometricReactant(ChemicalEntity entity,
                              ReactantRole role)

Creates a new StoichiometricReactant. Reaction order and spectrometric number are set to 1 .

Parameters:

entity - The referenced entity.

role - The reactant role.

Method Detail

getStoichiometricNumber

public double getStoichiometricNumber()

Returns the stoichiometric number (the number of molecules required for one reaction.).

Returns:

the stoichiometric number.

getReactionOrder

public double getReactionOrder()

Returns the reaction order.

Returns:

The reaction order.

isSubstrate

public boolean isSubstrate()

Returns true if this reactant is a substrate.

Returns:

true if this reactant is a substrate.

isProduct

public boolean isProduct()

Returns true if this reactant is a product.

Returns:

true if this reactant is a product.