alchemist/it.unibo.alchemist.core/Engine

Engine

open class Engine<T, P : Position<out P>?> : Simulation<T, P>

This class implements a simulation. It offers a wide number of static factories to ease the creation process.

Parameters

<T>

concentration type

Position type

Inheritors

BatchEngine

Constructors

Engine

constructor(environment: Environment<T, P>)

Builds a simulation for a given environment.

constructor(environment: Environment<T, P>, scheduler: Scheduler<T>)

Builds a simulation for a given environment.

Properties

environment

val environment: Environment<T, P>

error

open val error: Optional<Throwable>

status

open val status: Status

Functions

addOutputMonitor

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

getEnvironment

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

getError

abstract fun getError(): Optional<Throwable>

getOutputMonitors

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

Returns output monitors.

getStatus

abstract fun getStatus(): Status

getStep

open fun getStep(): Long

thread-safe.

getTime

open fun getTime(): Time

thread-safe.

goToStep

open fun goToStep(step: Long): CompletableFuture<Void>

goToTime

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

neighborAdded

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

neighborRemoved

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

nodeAdded

open fun nodeAdded(node: Node<T>)

nodeMoved

open fun nodeMoved(node: Node<T>)

nodeRemoved

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

pause

open fun pause(): CompletableFuture<Void>

pause.

play

open fun play(): CompletableFuture<Void>

play.

reactionAdded

open fun reactionAdded(reactionToAdd: Actionable<T>)

reactionRemoved

open fun reactionRemoved(reactionToRemove: Actionable<T>)

removeOutputMonitor

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

run

open fun run()

run simulation.

runInCurrentThread

@JvmStatic

fun <T, P : Position> Simulation<T, P>.runInCurrentThread(): Simulation<T, P>

Runs an existing Simulation in the current thread.

schedule

open fun schedule(runnable: CheckedRunnable)

startSimulation

fun <T, P : Position, Vector> Simulation<T, P>.startSimulation(onceInitialized: (EuclideanEnvironment<T, P>) -> Unit = { }, atEachStep: (EuclideanEnvironment<T, P>, Actionable<T>?, Time, Long) -> Unit = { _, _, _, _ -> }, whenFinished: (EuclideanEnvironment<T, P>, Time, Long) -> Unit = { _, _, _ -> }, steps: Long = 10000): EuclideanEnvironment<T, P>

Run the simulation this environment owns.

terminate

open fun terminate(): CompletableFuture<Void>

terminate.

terminatingAfterSteps

@JvmStatic

fun <T, P : Position> Simulation<T, P>.terminatingAfterSteps(finalStep: Long): Simulation<T, P>

toGraphQLSimulationSurrogate

fun <T, P : Position<out P>> Simulation<T, P>.toGraphQLSimulationSurrogate(): SimulationSurrogate<T, P>

Converts a Simulation to a SimulationSurrogate.

toString

open fun toString(): String

waitFor

open fun waitFor(next: Status, timeout: Long, tu: TimeUnit): Status