Package org.opentcs.data.order
Enum Class DriveOrder.State
- All Implemented Interfaces:
Serializable
,Comparable<DriveOrder.State>
,Constable
- Enclosing class:
DriveOrder
Defines the various potential states of a drive order.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionMarks a drive order as failed.Marks a drive order as successfully completed.Indicates the vehicle processing the order is currently executing an operation.A drive order's initial state, indicating it being still untouched/not being processed.Indicates the vehicle processing the order is currently moving to its destination. -
Method Summary
Modifier and TypeMethodDescriptionstatic DriveOrder.State
Returns the enum constant of this class with the specified name.static DriveOrder.State[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PRISTINE
A drive order's initial state, indicating it being still untouched/not being processed. -
TRAVELLING
Indicates the vehicle processing the order is currently moving to its destination. -
OPERATING
Indicates the vehicle processing the order is currently executing an operation. -
FINISHED
Marks a drive order as successfully completed. -
FAILED
Marks a drive order as failed.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-