Package org.opentcs.data.order

Enum-Klasse TransportOrder.State

java.lang.Object
java.lang.Enum<TransportOrder.State>
org.opentcs.data.order.TransportOrder.State
Alle implementierten Schnittstellen:
Serializable, Comparable<TransportOrder.State>, Constable
Umschließende Klasse:
TransportOrder
public static enum TransportOrder.State extends Enum<TransportOrder.State>
This enumeration defines the various states a transport order may be in.

  • Verschachtelte Klassen - Übersicht

    Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum-Konstanten - Übersicht

    Enum-Konstanten
    Enum-Konstante
    Beschreibung
    ACTIVE
    Set (by a user/client) when a transport order's parameters have been set up completely and the kernel should dispatch it when possible.
    BEING_PROCESSED
    Marks a transport order as being processed by a vehicle.
    DISPATCHABLE
    Marks a transport order as ready to be dispatched to a vehicle (i.e. all its dependencies have been finished).
    FAILED
    General failure state that marks a transport order as failed.
    FINISHED
    Marks a transport order as successfully completed.
    RAW
    A transport order's initial state.
    UNROUTABLE
    Failure state that marks a transport order as unroutable, i.e. it is impossible to find a route that would allow a vehicle to process the transport order completely.
    WITHDRAWN
    Indicates the transport order is withdrawn from a processing vehicle but not yet in its final state (which will be FAILED), as the vehicle has not yet finished/cleaned up.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    boolean
    isFinalState()
    Checks if this state is a final state for a transport order.
    static TransportOrder.State
    valueOf(String name)
    Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
    static TransportOrder.State[]
    values()
    Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.

    Von Klasse geerbte Methoden java.lang.Enum

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

    Von Klasse geerbte Methoden java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum-Konstanten - Details

    • RAW

      public static final TransportOrder.State RAW
      A transport order's initial state. A transport order remains in this state until its parameters have been set up completely.

    • ACTIVE

      public static final TransportOrder.State ACTIVE
      Set (by a user/client) when a transport order's parameters have been set up completely and the kernel should dispatch it when possible.

    • DISPATCHABLE

      public static final TransportOrder.State DISPATCHABLE
      Marks a transport order as ready to be dispatched to a vehicle (i.e. all its dependencies have been finished).

    • BEING_PROCESSED

      public static final TransportOrder.State BEING_PROCESSED
      Marks a transport order as being processed by a vehicle.

    • WITHDRAWN

      public static final TransportOrder.State WITHDRAWN
      Indicates the transport order is withdrawn from a processing vehicle but not yet in its final state (which will be FAILED), as the vehicle has not yet finished/cleaned up.

    • FINISHED

      public static final TransportOrder.State FINISHED
      Marks a transport order as successfully completed.

    • FAILED

      public static final TransportOrder.State FAILED
      General failure state that marks a transport order as failed.

    • UNROUTABLE

      public static final TransportOrder.State UNROUTABLE
      Failure state that marks a transport order as unroutable, i.e. it is impossible to find a route that would allow a vehicle to process the transport order completely.

  • Methodendetails

    • values

      public static TransportOrder.State[] values()
      Gibt ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration zurück.
      Gibt zurück:
      ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration

    • valueOf

      public static TransportOrder.State valueOf(String name)
      Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enum-Konstante in dieser Klasse deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)
      Parameter:
      name - Name der zurückzugebenden Enumerationskonstante.
      Gibt zurück:
      Enumerationskonstante mit dem angegebenen Namen
      Löst aus:
      IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält
      NullPointerException - wenn das Argument nicht angegeben wird

    • isFinalState

      public boolean isFinalState()
      Checks if this state is a final state for a transport order.
      Gibt zurück:
      true if, and only if, this state is a final state for a transport order - i.e. FINISHED, FAILED or UNROUTABLE.