Package com.scaleoutsoftware.digitaltwin.core

Enum Class SimulationStatus

java.lang.Object

java.lang.Enum<SimulationStatus>

com.scaleoutsoftware.digitaltwin.core.SimulationStatus

All Implemented Interfaces:

Serializable, Comparable<SimulationStatus>, Constable

public enum SimulationStatus
extends Enum<SimulationStatus>

The status of a simulation.

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
EndTimeReached	The simulation end time has been reached.
InstanceRequestedStop	A digital twin instance has requested the simulation to stop by calling SimulationController.stopSimulation()
NoRemainingWork	There is no remaining work for the simulation.
NotSet	The simulation status is not set.
Running	The simulation is running.
UnexpectedChangeInConfiguration	There was a runtime-change of simulation configuration.
UserRequested	The user requested a stop.

Method Summary

Modifier and Type	Method	Description
static SimulationStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SimulationStatus[]	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

Running

public static final SimulationStatus Running

The simulation is running.

NotSet

public static final SimulationStatus NotSet

The simulation status is not set.

UserRequested

public static final SimulationStatus UserRequested

The user requested a stop.

EndTimeReached

public static final SimulationStatus EndTimeReached

The simulation end time has been reached.

NoRemainingWork

public static final SimulationStatus NoRemainingWork

There is no remaining work for the simulation.

InstanceRequestedStop

public static final SimulationStatus InstanceRequestedStop

A digital twin instance has requested the simulation to stop by calling SimulationController.stopSimulation()

UnexpectedChangeInConfiguration

public static final SimulationStatus UnexpectedChangeInConfiguration

There was a runtime-change of simulation configuration.

Method Details

values

public static SimulationStatus[] 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 SimulationStatus 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