bio.singa.simulation.trajectories.flat

Class FlatUpdateRecorder

java.lang.Object

bio.singa.simulation.trajectories.flat.FlatUpdateRecorder

All Implemented Interfaces:

bio.singa.core.events.UpdateEventListener<UpdatableUpdatedEvent>

public class FlatUpdateRecorder
extends Object
implements bio.singa.core.events.UpdateEventListener<UpdatableUpdatedEvent>

This class can be used to write the concentration of chemical entities of a node and the changes applied to the node to a file. The updates are written each time a event is received. The events can be scheduled by using the SimulationManager.setUpdateEmissionCondition(Predicate). A node is observed by calling addUpdatableToObserve(Updatable).

Author:

cl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FlatUpdateRecorder.BuildStep
static interface	FlatUpdateRecorder.ConcentrationUnitStep
static interface	FlatUpdateRecorder.DirectoryStep
static class	FlatUpdateRecorder.EpochUpdateWriterBuilder
static interface	FlatUpdateRecorder.SimulationStep
static interface	FlatUpdateRecorder.TimeUnitStep
static interface	FlatUpdateRecorder.WorkspaceStep

Constructor Summary

Constructors

Constructor and Description
FlatUpdateRecorder()

Method Summary

Modifier and Type	Method and Description
void	addUpdatableToObserve(Updatable updatable) Initializes a updatable that will be observed during simulation.
void	closeWriters() Close all associated writers.
static FlatUpdateRecorder.WorkspaceStep	create()
Path	getWorkspaceFolder()
void	onEventReceived(UpdatableUpdatedEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatUpdateRecorder

public FlatUpdateRecorder()

Method Detail

create

public static FlatUpdateRecorder.WorkspaceStep create()

getWorkspaceFolder

public Path getWorkspaceFolder()

addUpdatableToObserve

public void addUpdatableToObserve(Updatable updatable)
                           throws IOException

Initializes a updatable that will be observed during simulation. Also prepares the files that will be written during simulation.

Parameters:

updatable - The updatable to be observed.

Throws:

IOException - If the file can not be created.

closeWriters

public void closeWriters()

Close all associated writers. Usually called after simulation finishes.

onEventReceived

public void onEventReceived(UpdatableUpdatedEvent event)

Specified by:

onEventReceived in interface bio.singa.core.events.UpdateEventListener<UpdatableUpdatedEvent>