Package nl.tudelft.simulation.dsol.simulators

Enum Class ReplicationState

java.lang.Object
java.lang.Enum<ReplicationState>
nl.tudelft.simulation.dsol.simulators.ReplicationState
All Implemented Interfaces:
Serializable, Comparable<ReplicationState>, java.lang.constant.Constable
public enum ReplicationState extends Enum<ReplicationState>
ReplicationState indicates the precise state of the replication that is being executed by 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; the END_REPLICATION_EVENT has been fired.
    ENDING
    The replication has ended, but the run() thread is still running; the END_REPLICATION_EVENT has not yet been fired.
    INITIALIZED
    The simulator has been initialized with the replication, but it has not been started yet, and the the START_REPLICATION_EVENT has not yet been fired.
    NOT_INITIALIZED
    The simulator has been instantiated, but not yet initialized with a Replication.
    STARTED
    The execution of the replication has started, the START_REPLICATION_EVENT has been fired.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ReplicationState
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ReplicationState[]
    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 ReplicationState NOT_INITIALIZED
      The simulator has been instantiated, but not yet initialized with a Replication.

    • INITIALIZED

      public static final ReplicationState INITIALIZED
      The simulator has been initialized with the replication, but it has not been started yet, and the the START_REPLICATION_EVENT has not yet been fired.

    • STARTED

      public static final ReplicationState STARTED
      The execution of the replication has started, the START_REPLICATION_EVENT has been fired.

    • ENDING

      public static final ReplicationState ENDING
      The replication has ended, but the run() thread is still running; the END_REPLICATION_EVENT has not yet been fired.

    • ENDED

      public static final ReplicationState ENDED
      The replication has ended, and the simulator cannot be restarted; the END_REPLICATION_EVENT has been fired.

  • Method Details

    • values

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