DisplacementBasedModule (singa-simulation 0.7.0 API)

java.lang.Object
- bio.singa.simulation.model.modules.AbstractUpdateModule
- - bio.singa.simulation.model.modules.displacement.DisplacementBasedModule

All Implemented Interfaces:

UpdateModule, Runnable

Direct Known Subclasses:

EndocytosisActinBoost, VesicleConfinedDiffusion, VesicleCytoplasmDiffusion, VesicleTransport
```
public class DisplacementBasedModule
extends AbstractUpdateModule
```
Author:

cl

Constructor Summary

Constructors
Constructor Description

DisplacementBasedModule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDeltaFunction(Function<Vesicle,DisplacementDelta> deltaFunction, Predicate<Vesicle> predicate)`
`void`	`calculateUpdates()`
`DisplacementDeviation`	`determineLocalDeviation()`
`void`	`initialize()`
`void`	`onCompletion()`
`void`	`onReset()`
`void`	`optimizeTimeStep()`
`String`	`toString()`

Methods inherited from class bio.singa.simulation.model.modules.AbstractUpdateModule
addEvidence, addReferencedEntities, addReferencedEntity, checkFeatures, equals, getEvidence, getFeature, getFeatureManager, getFeatures, getIdentifier, getReferencedChemicalEntities, getRequiredFeatures, getScaledFeature, getSimulation, getState, hashCode, reset, run, setEvidence, setFeature, setFeatureManager, setIdentifier, setSimulation, setState

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- DisplacementBasedModule
```
public DisplacementBasedModule()
```

Method Detail

addDeltaFunction

public void addDeltaFunction(Function<Vesicle,DisplacementDelta> deltaFunction,
                             Predicate<Vesicle> predicate)

initialize
```
public void initialize()
```

onReset
```
public void onReset()
```

onCompletion
```
public void onCompletion()
```

calculateUpdates
```
public void calculateUpdates()
```
Specified by:

calculateUpdates in class AbstractUpdateModule

determineLocalDeviation

public DisplacementDeviation determineLocalDeviation()

optimizeTimeStep
```
public void optimizeTimeStep()
```
Specified by:

optimizeTimeStep in class AbstractUpdateModule

toString
```
public String toString()
```
Overrides:

toString in class AbstractUpdateModule