Package edu.cnu.mdi.sim

Enum Class SimulationState

java.lang.Object

java.lang.Enum<SimulationState>

edu.cnu.mdi.sim.SimulationState

All Implemented Interfaces:

Serializable, Comparable<SimulationState>, Constable

public enum SimulationState
extends Enum<SimulationState>

Simulation engine states. These represent what the engine "is" currently doing.

States are owned and managed by SimulationEngine. Clients typically observe state transitions via SimulationListener.onStateChange(SimulationContext, SimulationState, SimulationState, String).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The engine encountered an unrecoverable error.
INITIALIZING	Simulation.init(SimulationContext) is being executed on the simulation thread.
NEW	Engine created but not started.
PAUSED	The engine is paused and not executing steps.
READY	Initialization is complete; engine is ready to run.
RUNNING	The engine is actively executing Simulation.step(SimulationContext) in a loop.
TERMINATED	The simulation ended normally (or via stop/cancel) and shutdown has completed.
TERMINATING	The engine is terminating due to stop/cancel/completion.

Method Summary

Modifier and Type	Method	Description
static SimulationState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SimulationState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEW

public static final SimulationState NEW

Engine created but not started.

INITIALIZING

public static final SimulationState INITIALIZING

Simulation.init(SimulationContext) is being executed on the simulation thread.

READY

public static final SimulationState READY

Initialization is complete; engine is ready to run.

RUNNING

public static final SimulationState RUNNING

The engine is actively executing Simulation.step(SimulationContext) in a loop.

PAUSED

public static final SimulationState PAUSED

The engine is paused and not executing steps. It can be resumed.

TERMINATING

public static final SimulationState TERMINATING

The engine is terminating due to stop/cancel/completion.

TERMINATED

public static final SimulationState TERMINATED

The simulation ended normally (or via stop/cancel) and shutdown has completed.

FAILED

public static final SimulationState FAILED

The engine encountered an unrecoverable error.

Method Details

values

public static SimulationState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SimulationState valueOf(String name)

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

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null