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

Class CatalyticReactant

java.lang.Object

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

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

public class CatalyticReactant
extends Reactant

CatalyticReactants are Reactants that are not consumed or produced during Reactions, but influence its velocity (reaction rate). An ReactantRole.INCREASING role is associated with an increase in velocity. ReactantRole.DECREASING associates an inhibition of the reaction.

Constructor Summary

Constructors

Constructor and Description
CatalyticReactant(ChemicalEntity entity, ReactantRole role) Creates a new catalytic reactant.

Method Summary

Modifier and Type	Method and Description
double	getStrength() Gets the strength of this Reactant.
boolean	isAccelerator() Returns true if this Reactant is increasing the velocity of the associated reaction, and false otherwise.
boolean	isInhibitor() Returns true if this Reactant is decreasing the velocity of the associated reaction, and false otherwise.
void	setStrength(double strength) Sets the strength of this Reactant.

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

CatalyticReactant

public CatalyticReactant(ChemicalEntity entity,
                         ReactantRole role)

Creates a new catalytic reactant.

Parameters:

entity - The referenced entity.

role - The reactants role.

Method Detail

getStrength

public double getStrength()

Gets the strength of this Reactant.

Returns:

The strength of this Reactant.

setStrength

public void setStrength(double strength)

Sets the strength of this Reactant.

Parameters:

strength - The strength of this Reactant.

isAccelerator

public boolean isAccelerator()

Returns true if this Reactant is increasing the velocity of the associated reaction, and false otherwise.

Returns:

true if this Reactant is increasing the velocity of the associated reaction, and false otherwise.

isInhibitor

public boolean isInhibitor()

Returns true if this Reactant is decreasing the velocity of the associated reaction, and false otherwise.

Returns:

true if this Reactant is decreasing the velocity of the associated reaction, and false otherwise.