Enum SimulationStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SimulationStatus>, java.lang.constant.Constable

    public enum SimulationStatus
    extends java.lang.Enum<SimulationStatus>
    The status of a simulation.
    • Nested Class Summary

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

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
    • Method Summary

      Modifier and Type Method Description
      static SimulationStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SimulationStatus[] values()
      Returns an array containing the constants of this enum type, 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 Detail

      • 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.
      • UnexpectedChangeInConfiguration

        public static final SimulationStatus UnexpectedChangeInConfiguration
        There was a runtime-change of simulation configuration.
    • Method Detail

      • values

        public static SimulationStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SimulationStatus valueOf​(java.lang.String name)
        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.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null