Enum Class DriveOrder.State

java.lang.Object
java.lang.Enum<DriveOrder.State>
org.opentcs.data.order.DriveOrder.State
All Implemented Interfaces:
Serializable, Comparable<DriveOrder.State>, Constable
Enclosing class:
DriveOrder

public static enum DriveOrder.State extends Enum<DriveOrder.State>
Defines the various potential states of a drive order.
  • Enum Constant Details

    • PRISTINE

      public static final DriveOrder.State PRISTINE
      A drive order's initial state, indicating it being still untouched/not being processed.
    • TRAVELLING

      public static final DriveOrder.State TRAVELLING
      Indicates the vehicle processing the order is currently moving to its destination.
    • OPERATING

      public static final DriveOrder.State OPERATING
      Indicates the vehicle processing the order is currently executing an operation.
    • FINISHED

      public static final DriveOrder.State FINISHED
      Marks a drive order as successfully completed.
    • FAILED

      public static final DriveOrder.State FAILED
      Marks a drive order as failed.
  • Method Details

    • values

      public static DriveOrder.State[] 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 DriveOrder.State 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