Package nl.tudelft.simulation.dsol.simulators

Enum Class RunState

java.lang.Object
java.lang.Enum<RunState>
nl.tudelft.simulation.dsol.simulators.RunState
All Implemented Interfaces:
Serializable, Comparable<RunState>, java.lang.constant.Constable
public enum RunState extends Enum<RunState>
RunState indicates the precise state of the Simulator.

Copyright (c) 2020-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:
Alexander Verbraeck

  • 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
    ENDED
    The replication has ended, and the simulator cannot be restarted.
    INITIALIZED
    The replication has started, and the simulator has been initialized, but it has not been started yet.
    NOT_INITIALIZED
    The simulator has been instantiated, but not yet initialized with a Replication.
    STARTED
    The Simulator run() thread has started; the simulation is running.
    STARTING
    The Simulator has been started, but the run() thread did not start yet.
    STOPPED
    The Simulator run() thread has been stopped; the simulator is not running.
    STOPPING
    The stopping of the simulator has been initiated, but the run() thread is still running.

  • Method Summary

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

    • NOT_INITIALIZED

      public static final RunState NOT_INITIALIZED
      The simulator has been instantiated, but not yet initialized with a Replication.

    • INITIALIZED

      public static final RunState INITIALIZED
      The replication has started, and the simulator has been initialized, but it has not been started yet.

    • STARTING

      public static final RunState STARTING
      The Simulator has been started, but the run() thread did not start yet.

    • STARTED

      public static final RunState STARTED
      The Simulator run() thread has started; the simulation is running.

    • STOPPING

      public static final RunState STOPPING
      The stopping of the simulator has been initiated, but the run() thread is still running.

    • STOPPED

      public static final RunState STOPPED
      The Simulator run() thread has been stopped; the simulator is not running.

    • ENDED

      public static final RunState ENDED
      The replication has ended, and the simulator cannot be restarted.

  • Method Details

    • values

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