de.bioforscher.singa.simulation.model.concentrations

Class Delta

java.lang.Object

de.bioforscher.singa.simulation.model.concentrations.Delta

public class Delta
extends Object

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

Author:

cl

Constructor Summary

Constructors

Constructor and Description
Delta(CellSection cellSection, ChemicalEntity chemicalEntity, javax.measure.Quantity<MolarConcentration> quantity) Creates a new delta for a specific ChemicalEntity in a specific CellSection.

Method Summary

Modifier and Type	Method and Description
CellSection	getCellSection() Returns the cell section.
ChemicalEntity	getChemicalEntity() Returns the chemical entity.
javax.measure.Quantity<MolarConcentration>	getQuantity() Returns the quantity of the change.
Delta	merge(Delta anotherDelta) Merges (adds) two deltas an returns a new delta.
Delta	multiply(double multiplicand) Multiplies (modifies) this delta .
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Delta

public Delta(CellSection cellSection,
             ChemicalEntity chemicalEntity,
             javax.measure.Quantity<MolarConcentration> quantity)

Creates a new delta for a specific ChemicalEntity in a specific CellSection.

Parameters:

cellSection - The cell section.

chemicalEntity - The chemical entity.

quantity - The change in concentration.

Method Detail

getCellSection

public CellSection getCellSection()

Returns the cell section.

Returns:

The cell section.

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 Delta multiply(double multiplicand)

Multiplies (modifies) this delta .

Parameters:

multiplicand - The scalar that the delta is multiplied with.

Returns:

This multiplied delta.

merge

public Delta merge(Delta anotherDelta)

Merges (adds) two deltas an returns a new delta.

Parameters:

anotherDelta - The other delta.

Returns:

A new delta with the accumulated changes.

toString

public String toString()

Overrides:

toString in class Object