Package org.opentcs.data.order
Class DriveOrder
java.lang.Object
org.opentcs.data.order.DriveOrder
- All Implemented Interfaces:
java.io.Serializable
public class DriveOrder
extends java.lang.Object
implements java.io.Serializable
Describes a sequence of movements and an optional operation at the end that a
Vehicle is
supposed to execute.- See Also:
TransportOrder, Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDriveOrder.DestinationDescribes the destination of a drive order.static classDriveOrder.StateDefines the various potential states of a drive order. -
Constructor Summary
Constructors Constructor Description DriveOrder(DriveOrder.Destination destination)Creates a new DriveOrder. -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object obj)DriveOrder.DestinationgetDestination()Returns this drive order's destination.RoutegetRoute()Returns this drive order's route.DriveOrder.StategetState()Returns this drive order's state.TCSObjectReference<TransportOrder>getTransportOrder()Returns a reference to the transport order this drive order belongs to.inthashCode()java.lang.StringtoString()DriveOrderwithRoute(Route route)Creates a copy of this object, with the given route.DriveOrderwithState(DriveOrder.State state)Creates a copy of this object, with the given state.DriveOrderwithTransportOrder(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
nullif 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
public boolean equals(java.lang.Object obj)- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toStringin classjava.lang.Object
-