Package org.opentcs.data.order
Enum DriveOrder.State
java.lang.Object
java.lang.Enum<DriveOrder.State>
org.opentcs.data.order.DriveOrder.State
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<DriveOrder.State>,java.lang.constant.Constable
- Enclosing class:
- DriveOrder
public static enum DriveOrder.State extends java.lang.Enum<DriveOrder.State>
Defines the various potential states of a drive order.
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description FAILEDMarks a drive order as failed.FINISHEDMarks a drive order as successfully completed.OPERATINGIndicates the vehicle processing the order is currently executing an operation.PRISTINEA drive order's initial state, indicating it being still untouched/not being processed.TRAVELLINGIndicates the vehicle processing the order is currently moving to its destination. -
Method Summary
Modifier and Type Method Description static DriveOrder.StatevalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static DriveOrder.State[]values()Returns an array containing the constants of this enum type, 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 type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 namejava.lang.NullPointerException- if the argument is null
-