de.bioforscher.singa.simulation.modules.reactions.model

Class Reactant

java.lang.Object

de.bioforscher.singa.simulation.modules.reactions.model.Reactant

Direct Known Subclasses:

CatalyticReactant, StoichiometricReactant

public abstract class Reactant
extends Object

A Reactant encapsulates a ChemicalEntity for the use in Reactions. This abstract class has currently two implementations StoichiometricReactants are Reactants that are consumed or produced during the reaction. CatalyticReactants are influencing the velocity (reaction rate), but are not consumed or produced.

Constructor Summary

Constructors

Constructor and Description
Reactant(ChemicalEntity<?> entity, ReactantRole role)

Method Summary

Modifier and Type	Method and Description
ChemicalEntity<?>	getEntity() Gets the entity representing this reactant.
ReactantRole	getRole() Gets the role of this reactant.
void	setEntity(ChemicalEntity<?> entity) Sets the entity representing this reactant.
void	setRole(ReactantRole role) Gets the role of this reactant.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reactant

public Reactant(ChemicalEntity<?> entity,
                ReactantRole role)

Method Detail

getEntity

public ChemicalEntity<?> getEntity()

Gets the entity representing this reactant.

Returns:

The entity representing this reactant.

setEntity

public void setEntity(ChemicalEntity<?> entity)

Sets the entity representing this reactant.

Parameters:

entity - The entity representing this reactant.

getRole

public ReactantRole getRole()

Gets the role of this reactant.

Returns:

The role of this reactant.

setRole

public void setRole(ReactantRole role)

Gets the role of this reactant.

Parameters:

role - The role of this reactant.