alchemist-api/it.unibo.alchemist.core/Simulation

Simulation

interface Simulation<T, P : Position<out P>?> : Runnable(source)

This interface forces simulations to be independent threads, and make them controllable from an external console.

Parameters

<T>

Concentration type

<P>

Position Type

Functions

addOutputMonitor

abstract fun addOutputMonitor(op: OutputMonitor<T, P>)

Adds an OutputMonitor to this simulation.

abstract fun getEnvironment(): Environment<T, P>

Allows to access the current environment.

abstract fun getError(): Optional<Throwable>

getOutputMonitors

abstract fun getOutputMonitors(): List<OutputMonitor<T, P>>

Allows to access a list of all the OutputMonitor currently attached to this simulation.

abstract fun getStatus(): Status

Allows to access the current status.

abstract fun getStep(): Long

Allows to access the current simulation step.

abstract fun getTime(): Time

Allows to know which is the current simulation time.

abstract fun goToStep(steps: Long): CompletableFuture<Void>

Executes a certain number of steps, then pauses it.

abstract fun goToTime(t: Time): CompletableFuture<Void>

Executes the simulation until the target time is reached, then pauses it.

abstract fun neighborAdded(node: Node<T>, n: Node<T>)

This method must get called in case a communication link connecting two nodes gets created during the simulation.

neighborRemoved

abstract fun neighborRemoved(node: Node<T>, n: Node<T>)

This method must get called in case a a communication link connecting two nodes gets broken during the simulation.

abstract fun nodeAdded(node: Node<T>)

This method must get called in case a node is added to the environment during the simulation and after its neighborhood has been computed (or can be consistently computed by the simulated environment).

abstract fun nodeMoved(node: Node<T>)

This method must get called in case a node is moved in the environment during the simulation and after its neighborhood has been computed (or can be consistently computed by the simulated environment).

abstract fun nodeRemoved(node: Node<T>, oldNeighborhood: Neighborhood<T>)

This method must get called in case a node is removed from the environment during the simulation and after its neighborhood has been computed (or can be consistently computed by the simulated environment).

abstract fun pause(): CompletableFuture<Void>

Sends a pause command to the simulation.

abstract fun play(): CompletableFuture<Void>

Sends a play command to the simulation.

abstract fun reactionAdded(reactionToAdd: Actionable<T>)

Adds a reaction during the simulation to the scheduler and start to execute it.

reactionRemoved

abstract fun reactionRemoved(reactionToRemove: Actionable<T>)

Removes a reaction during the simulation from the scheduler and stop to execute it.

removeOutputMonitor

abstract fun removeOutputMonitor(op: OutputMonitor<T, P>)

Removes an OutputMonitor to this simulation.

abstract fun run()

abstract fun schedule(r: CheckedRunnable)

Schedules a runnable to be executed by the Simulation thread, useful for synchronization purposes (e.g.

abstract fun terminate(): CompletableFuture<Void>

Sends a terminate command to the simulation.

abstract fun waitFor(s: Status, timeout: Long, timeunit: TimeUnit): Status

Suspends the caller until the simulation reaches the selected Status or the timeout ends.