alchemist/it.unibo.alchemist.core/SimulationState

SimulationState

enum SimulationState : Enum<SimulationState>

The possible states of a Simulation. The order of the entries follows the simulation lifecycle, and isReachableFrom relies on it.

Entries

The simulation is being initialized.

The simulation is ready to be started.

The simulation is paused. It can be resumed.

The simulation is currently running.

The simulation is stopped. It is no longer possible to resume it.

Properties

val entries: EnumEntries<SimulationState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

Functions

isReachableFrom

fun isReachableFrom(origin: SimulationState): Boolean

Whether the simulation lifecycle allows getting to this state from origin.

toStatusSurrogate

fun SimulationState.toStatusSurrogate(): StatusSurrogate

Map a SimulationState to StatusSurrogate.

fun valueOf(value: String): SimulationState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<SimulationState>

Returns an array containing the constants of this enum type, in the order they're declared.