Package org.opentcs.data.order
Class DriveOrder
java.lang.Object
org.opentcs.data.order.DriveOrder
- All Implemented Interfaces:
Serializable
Describes a sequence of movements and an optional operation at the end that a
Vehicle
is
supposed to execute.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Describes the destination of a drive order.static enum
Defines the various potential states of a drive order. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns this drive order's destination.getRoute()
Returns this drive order's route.getState()
Returns this drive order's state.Returns a reference to the transport order this drive order belongs to.int
hashCode()
toString()
Creates a copy of this object, with the given route.withState
(DriveOrder.State state) Creates a copy of this object, with the given state.withTransportOrder
(TCSObjectReference<TransportOrder> transportOrder) Creates a copy of this object, with the given transport order.
-
Constructor Details
-
DriveOrder
Creates a new DriveOrder.- Parameters:
destination
- This drive order's destination.
-
-
Method Details
-
getDestination
Returns this drive order's destination.- Returns:
- This drive order's destination.
-
getTransportOrder
Returns a reference to the transport order this drive order belongs to.- Returns:
- A reference to the transport order this drive order belongs to.
-
withTransportOrder
Creates a copy of this object, with the given transport order.- Parameters:
transportOrder
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getRoute
Returns this drive order's route.- Returns:
- This drive order's route. May be
null
if this drive order's route hasn't been calculated, yet.
-
withRoute
Creates a copy of this object, with the given route.- Parameters:
route
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getState
Returns this drive order's state.- Returns:
- This drive order's state.
-
withState
Creates a copy of this object, with the given state.- Parameters:
state
- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
equals
-
hashCode
public int hashCode() -
toString
-