Package org.opentcs.data.order
Class Route.Step
java.lang.Object
org.opentcs.data.order.Route.Step
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- Route
public static class Route.Step
extends java.lang.Object
implements java.io.Serializable
A single step in a route.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description Step(Path path, Point srcPoint, Point destPoint, Vehicle.Orientation orientation, int routeIndex)Creates a new instance.Step(Path path, Point srcPoint, Point destPoint, Vehicle.Orientation orientation, int routeIndex, boolean executionAllowed)Creates a new instance. -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object o)PointgetDestinationPoint()Returns the point that is reached by travelling the path.PathgetPath()Returns the path to travel.intgetRouteIndex()Returns this step's index in the vehicle's route.PointgetSourcePoint()Returns the point that the vehicle is starting from.Vehicle.OrientationgetVehicleOrientation()Returns the direction into which the vehicle is supposed to travel.inthashCode()booleanisExecutionAllowed()Returns whether execution of this step is allowed.java.lang.StringtoString()
-
Constructor Details
-
Step
public Step(@Nullable Path path, @Nullable Point srcPoint, @Nonnull Point destPoint, @Nonnull Vehicle.Orientation orientation, int routeIndex, boolean executionAllowed)Creates a new instance.- Parameters:
path- The path to travel.srcPoint- The point that the vehicle is starting from.destPoint- The point that is reached by travelling the path.orientation- The vehicle's orientation on this step.routeIndex- This step's index in the vehicle's route.executionAllowed- Whether execution of this step is allowed.
-
Step
public Step(@Nullable Path path, @Nullable Point srcPoint, @Nonnull Point destPoint, @Nonnull Vehicle.Orientation orientation, int routeIndex)Creates a new instance.- Parameters:
path- The path to travel.srcPoint- The point that the vehicle is starting from.destPoint- The point that is reached by travelling the path.orientation- The vehicle's orientation on this step.routeIndex- This step's index in the vehicle's route.
-
-
Method Details
-
getPath
Returns the path to travel.- Returns:
- The path to travel. May be
nullif the vehicle does not really have to move.
-
getSourcePoint
Returns the point that the vehicle is starting from.- Returns:
- The point that the vehicle is starting from.
May be
nullif the vehicle does not really have to move.
-
getDestinationPoint
Returns the point that is reached by travelling the path.- Returns:
- The point that is reached by travelling the path.
-
getVehicleOrientation
Returns the direction into which the vehicle is supposed to travel.- Returns:
- The direction into which the vehicle is supposed to travel.
-
getRouteIndex
public int getRouteIndex()Returns this step's index in the vehicle's route.- Returns:
- This step's index in the vehicle's route.
-
isExecutionAllowed
public boolean isExecutionAllowed()Returns whether execution of this step is allowed.- Returns:
true, if execution of this step is allowed, otherwisefalse.
-
equals
public boolean equals(java.lang.Object o)- 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
-