alchemist-engine/it.unibo.alchemist.core/Engine

Engine

open class Engine<T, P : Position<out P>>(environment: Environment<T, P>, scheduler: Scheduler<T>) : AbstractEngine<T, P> (source)

Represents a simulation engine that manages execution and scheduling. Provides multiple factory methods to simplify the creation process.

Parameters

environment

the simulation environment

Type Parameters

the concentration type

the position type, extending Position

Constructors

Engine

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

constructor(environment: Environment<T, P>)

Properties

environment

override val environment: Environment<T, P>

the simulation environment

error

override var error: Option<Throwable>

The error that made the simulation fail, if any.

outputMonitors

override val outputMonitors: List<OutputMonitor<T, P>>

The registered output monitors, as a read-only view.

state

@Volatile

override var state: SimulationState

The current simulation status.

step

override val step: Long

The current step (thread-safe).

time

override val time: Time

The current simulation time (thread-safe).

Functions

addOutputMonitor

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

Adds an output monitor to track simulation events.

goToStep

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

Moves the simulation forward until the given step is reached.

goToTime

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

Moves the simulation forward until the given time is reached.

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: Reaction<T>)

reactionInvalidated

open override fun reactionInvalidated(reactionToUpdate: Reaction<T>)

reactionRemoved

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

removeOutputMonitor

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

run

open override fun run()

Internal method to run the simulation loop. Implementations must provide initialize, doStep, and hooks for run cycle.

schedule

open override fun schedule(action: () -> Unit)

Schedules a task for execution.

terminate

open override fun terminate(): CompletableFuture<Unit>

Terminates the simulation.

toString

open override fun toString(): String

waitFor

open override fun waitFor(state: SimulationState, timeout: Long, timeunit: TimeUnit): SimulationState

Waits for the simulation to reach a given status.