alchemist/it.unibo.alchemist.core/BatchEngine

BatchEngine

class BatchEngine<T, P : Position<out P>> : Engine<T, P>

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

Parameters

[Position] type

Constructors

constructor(environment: Environment<T, P>, scheduler: BatchedScheduler<T>, outputReplayStrategy: String = "aggregate")

constructor(environment: Environment<T, P>, scheduler: String, batchSizeOrEpsilon: Number, outputReplayStrategy: String = "aggregate")

Functions

addOutputMonitor

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

Adds an output monitor to track simulation events.

getEnvironment

open override fun getEnvironment(): Environment<T, P>

getError

open override fun getError(): Optional<Throwable>

getOutputMonitors

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

getStatus

open override fun getStatus(): Status

getStep

open override fun getStep(): Long

getTime

open override fun getTime(): Time

goToStep

open override fun goToStep(step: Long): CompletableFuture<Unit>

Moves the simulation forward until the given step is reached.

goToTime

open override fun goToTime(t: Time): CompletableFuture<Unit>

Moves the simulation forward until the given time is reached.

neighborAdded

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

Registers a newly added neighbor.

neighborRemoved

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

Registers a removed neighbor.

nodeAdded

open override fun nodeAdded(node: Node<T>)

Handles the addition of a new node.

nodeMoved

open override fun nodeMoved(node: Node<T>)

Handles node movement.

nodeRemoved

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

Handles the removal of a node.

pause

open override fun pause(): CompletableFuture<Unit>

Pauses the simulation.

play

open override fun play(): CompletableFuture<Unit>

Resumes the simulation.

reactionAdded

open override fun reactionAdded(reactionToAdd: Actionable<T>)

Registers a newly added reaction.

reactionRemoved

open override fun reactionRemoved(reactionToRemove: Actionable<T>)

Registers a removed reaction.

removeOutputMonitor

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

run

open override fun run()

Runs the simulation.

runInCurrentThread

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

Runs an existing Simulation in the current thread.

schedule

open override fun schedule(runnable: <Error class: unknown class>)

Schedules a task for execution.

startSimulation

fun <T, P : Position<P>, Vector<P>> 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 override fun terminate(): CompletableFuture<Unit>

Terminates the simulation.

terminatingAfterSteps

fun <T, P : Position<P>> 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 override fun toString(): String

waitFor

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

Waits for the simulation to reach a given status.