Enum Class Vehicle.State

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

public static enum Vehicle.State extends Enum<Vehicle.State>
The elements of this enumeration describe the various possible states of a vehicle.
  • Enum Constant Details

    • UNKNOWN

      public static final Vehicle.State UNKNOWN
      The vehicle's current state is unknown, e.g. because communication with it is currently not possible for some reason.
    • UNAVAILABLE

      public static final Vehicle.State UNAVAILABLE
      The vehicle's state is known and it's not in an error state, but it is not available for receiving orders.
    • ERROR

      public static final Vehicle.State ERROR
      There is a problem with the vehicle.
    • IDLE

      public static final Vehicle.State IDLE
      The vehicle is currently idle/available for processing movement orders.
    • EXECUTING

      public static final Vehicle.State EXECUTING
      The vehicle is processing a movement order.
    • CHARGING

      public static final Vehicle.State CHARGING
      The vehicle is currently recharging its battery/refilling fuel.
  • Method Details

    • values

      public static Vehicle.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 Vehicle.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