bio.singa.simulation.model.simulation

Class SimulationManager

java.lang.Object

java.util.concurrent.FutureTask<V>

javafx.concurrent.Task<Simulation>

bio.singa.simulation.model.simulation.SimulationManager

All Implemented Interfaces:

Runnable, Future<Simulation>, RunnableFuture<Simulation>, javafx.concurrent.Worker<Simulation>, javafx.event.EventTarget

public class SimulationManager
extends javafx.concurrent.Task<Simulation>

Changes in simulations can be observed by tagging AutomatonNodes of the AutomatonGraph. As a standard implementation there is the EpochUpdateWriter that can be added to the Simulation that will write log files to the specified file locations.

Author:

cl

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.concurrent.Worker

javafx.concurrent.Worker.State

Constructor Summary

Constructors

Constructor and Description
SimulationManager(Simulation simulation) Creates a new simulation manager for the given simulation.

Method Summary

Modifier and Type	Method and Description
void	addGraphUpdateListener(UpdateEventListener<GraphUpdatedEvent> listener) Adds a new listener for graph based events.
void	addNodeUpdateListener(UpdateEventListener<UpdatableUpdatedEvent> listener) Adds a new listener for node based events.
protected Simulation	call()
protected void	done()
void	emitGraphEvent(Simulation simulation)
void	emitNodeEvent(Simulation simulation, Updatable updatable)
CopyOnWriteArrayList<UpdateEventListener<GraphUpdatedEvent>>	getGraphListeners()
CopyOnWriteArrayList<UpdateEventListener<UpdatableUpdatedEvent>>	getNodeListeners() Returns all currently registered node event listeners.
Simulation	getSimulation() Returns the simulation.
boolean	keepPlatformOpen()
void	setKeepPlatformOpen(boolean keepPlatformOpen)
void	setSimulationTerminationToEpochs(long numberOfEpochs) Schedules the termination of the simulation after the given number of epochs have passed.
void	setSimulationTerminationToTime(javax.measure.Quantity<javax.measure.quantity.Time> time) Schedules the termination of the simulation after the given time (simulation time) has passed.
void	setTerminationCondition(Predicate<Simulation> terminationCondition) Sets a condition determining when the simulation should be terminated.
void	setTerminationLatch(CountDownLatch terminationLatch)
void	setUpdateEmissionCondition(Predicate<Simulation> emitCondition) Sets a condition determining when events should be emitted.
void	setUpdateEmissionToTimePassed(javax.measure.Quantity<javax.measure.quantity.Time> timePassed) Schedules the emission of events after the given time (simulation time) has passed.
void	tieUpdateEmissionToFPS(int fps) Sets the emission of updates for a rending engine.

Methods inherited from class javafx.concurrent.Task

addEventFilter, addEventHandler, buildEventDispatchChain, cancel, cancel, cancelled, exceptionProperty, failed, fireEvent, getException, getMessage, getOnCancelled, getOnFailed, getOnRunning, getOnScheduled, getOnSucceeded, getProgress, getState, getTitle, getTotalWork, getValue, getWorkDone, isRunning, messageProperty, onCancelledProperty, onFailedProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, removeEventFilter, removeEventHandler, running, runningProperty, scheduled, setEventHandler, setOnCancelled, setOnFailed, setOnRunning, setOnScheduled, setOnSucceeded, stateProperty, succeeded, titleProperty, totalWorkProperty, updateMessage, updateProgress, updateProgress, updateTitle, updateValue, valueProperty, workDoneProperty

Methods inherited from class java.util.concurrent.FutureTask

get, get, isCancelled, isDone, run, runAndReset, set, setException

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulationManager

public SimulationManager(Simulation simulation)

Creates a new simulation manager for the given simulation.

Parameters:

simulation - The simulation.

Method Detail

addNodeUpdateListener

public void addNodeUpdateListener(UpdateEventListener<UpdatableUpdatedEvent> listener)

Adds a new listener for node based events.

Parameters:

listener - The listener.

getNodeListeners

public CopyOnWriteArrayList<UpdateEventListener<UpdatableUpdatedEvent>> getNodeListeners()

Returns all currently registered node event listeners.

Returns:

All currently registered node event listeners.

addGraphUpdateListener

public void addGraphUpdateListener(UpdateEventListener<GraphUpdatedEvent> listener)

Adds a new listener for graph based events.

Parameters:

listener - The listener.

getGraphListeners

public CopyOnWriteArrayList<UpdateEventListener<GraphUpdatedEvent>> getGraphListeners()

setTerminationCondition

public void setTerminationCondition(Predicate<Simulation> terminationCondition)

Sets a condition determining when the simulation should be terminated.

Parameters:

terminationCondition - The termination condition.

setSimulationTerminationToTime

public void setSimulationTerminationToTime(javax.measure.Quantity<javax.measure.quantity.Time> time)

Schedules the termination of the simulation after the given time (simulation time) has passed.

Parameters:

time - The time.

setSimulationTerminationToEpochs

public void setSimulationTerminationToEpochs(long numberOfEpochs)

Schedules the termination of the simulation after the given number of epochs have passed.

Parameters:

numberOfEpochs - The number of epochs.

setUpdateEmissionCondition

public void setUpdateEmissionCondition(Predicate<Simulation> emitCondition)

Sets a condition determining when events should be emitted.

Parameters:

emitCondition - The emission condition.

tieUpdateEmissionToFPS

public void tieUpdateEmissionToFPS(int fps)

Sets the emission of updates for a rending engine. If more epochs are processed than can be displayed the epochs in between are not emitted. If epoch calculation is slower each epoch is emitted.

Parameters:

fps - The frames (emits) per (real time) second.

setUpdateEmissionToTimePassed

public void setUpdateEmissionToTimePassed(javax.measure.Quantity<javax.measure.quantity.Time> timePassed)

Schedules the emission of events after the given time (simulation time) has passed.

Parameters:

timePassed - The (simulation) time passed.

setTerminationLatch

public void setTerminationLatch(CountDownLatch terminationLatch)

emitGraphEvent

public void emitGraphEvent(Simulation simulation)

emitNodeEvent

public void emitNodeEvent(Simulation simulation,
                          Updatable updatable)

keepPlatformOpen

public boolean keepPlatformOpen()

setKeepPlatformOpen

public void setKeepPlatformOpen(boolean keepPlatformOpen)

getSimulation

public Simulation getSimulation()

Returns the simulation.

Returns:

The simulation.

call

protected Simulation call()

Specified by:

call in class javafx.concurrent.Task<Simulation>

done

protected void done()

Overrides:

done in class FutureTask<Simulation>