bio.singa.simulation.model.modules.concentration

Class ConcentrationDelta

java.lang.Object

bio.singa.simulation.model.modules.concentration.ConcentrationDelta

public class ConcentrationDelta
extends Object

The delta object manages the change that will be applied to the concentration of a specific ChemicalEntity in a CellSubsection.

Author:

cl

Constructor Summary

Constructors

Constructor and Description
ConcentrationDelta(UpdateModule module, CellSubsection cellSubsection, ChemicalEntity chemicalEntity, javax.measure.Quantity<MolarConcentration> quantity) Creates a new concentration delta.

Method Summary

Modifier and Type	Method and Description
ConcentrationDelta	add(double summand)
CellSubsection	getCellSubsection() Returns the subsection.
ChemicalEntity	getChemicalEntity() Returns the chemical entity.
UpdateModule	getModule() Returns the module, that calculated this delta.
javax.measure.Quantity<MolarConcentration>	getQuantity() Returns the quantity of the change.
ConcentrationDelta	multiply(double multiplicand) Multiplies (modifies) this delta with the given multiplicand.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcentrationDelta

public ConcentrationDelta(UpdateModule module,
                          CellSubsection cellSubsection,
                          ChemicalEntity chemicalEntity,
                          javax.measure.Quantity<MolarConcentration> quantity)

Creates a new concentration delta.

Parameters:

module - The module the delta was calculated by.

cellSubsection - The subsection the delta is applied to

chemicalEntity - The chemical entity the delta is applied to.

quantity - The actual quantity of the change.

Method Detail

getModule

public UpdateModule getModule()

Returns the module, that calculated this delta.

Returns:

The module, that calculated this delta.

getCellSubsection

public CellSubsection getCellSubsection()

Returns the subsection.

Returns:

The subsection.

getChemicalEntity

public ChemicalEntity getChemicalEntity()

Returns the chemical entity.

Returns:

The chemical entity.

getQuantity

public javax.measure.Quantity<MolarConcentration> getQuantity()

Returns the quantity of the change.

Returns:

The quantity of the change.

multiply

public ConcentrationDelta multiply(double multiplicand)

Multiplies (modifies) this delta with the given multiplicand.

Parameters:

multiplicand - The scalar that the delta is multiplied with.

Returns:

This multiplied delta.

add

public ConcentrationDelta add(double summand)

toString

public String toString()

Overrides:

toString in class Object