bio.singa.simulation.events

Class EpochUpdateWriter

java.lang.Object

bio.singa.simulation.events.EpochUpdateWriter

All Implemented Interfaces:

UpdateEventListener<UpdatableUpdatedEvent>

public class EpochUpdateWriter
extends Object
implements 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 addNodeToObserve(AutomatonNode).

Author:

cl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EpochUpdateWriter.BuildStep
static interface	EpochUpdateWriter.ConcentrationUnitStep
static interface	EpochUpdateWriter.EntitiesStep
static class	EpochUpdateWriter.EpochUpdateWriterBuilder
static interface	EpochUpdateWriter.FolderStep
static interface	EpochUpdateWriter.ModulesStep
static interface	EpochUpdateWriter.SimulationStep
static interface	EpochUpdateWriter.TimeUnitStep
static interface	EpochUpdateWriter.WorkspaceStep

Constructor Summary

Constructors

Constructor and Description
EpochUpdateWriter()

Method Summary

Modifier and Type	Method and Description
void	addNodeToObserve(AutomatonNode node) Initializes a node that will be observed during simulation.
void	closeWriters() Close all associated writers.
static EpochUpdateWriter.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

EpochUpdateWriter

public EpochUpdateWriter()

Method Detail

create

public static EpochUpdateWriter.WorkspaceStep create()

addNodeToObserve

public void addNodeToObserve(AutomatonNode node)
                      throws IOException

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

Parameters:

node - The node 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 UpdateEventListener<UpdatableUpdatedEvent>

getWorkspaceFolder

public Path getWorkspaceFolder()