Package org.opentcs.data.order
Class Route.Step
java.lang.Object
org.opentcs.data.order.Route.Step
- All Implemented Interfaces:
Serializable
- Enclosing class:
Route
A single step in a route.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionStep
(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.Step
(Path path, Point srcPoint, Point destPoint, Vehicle.Orientation orientation, int routeIndex, boolean executionAllowed, ReroutingType reroutingType) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
equalsInMovement
(Route.Step step) Compares the given step to this step, ignoring rerouting-related properties.Returns the point that is reached by travelling the path.getPath()
Returns the path to travel.Returns theReroutingType
of this step.int
Returns this step's index in the vehicle's route.Returns the point that the vehicle is starting from.Returns the direction into which the vehicle is supposed to travel.int
hashCode()
boolean
Returns whether execution of this step is allowed.toString()
-
Constructor Details
-
Step
public Step(@Nullable Path path, @Nullable Point srcPoint, @Nonnull Point destPoint, @Nonnull Vehicle.Orientation orientation, int routeIndex, boolean executionAllowed, @Nullable ReroutingType reroutingType) 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.reroutingType
- Marks this step as the origin of a recalculated route.
-
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
null
if 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
null
if 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
.
-
getReroutingType
Returns theReroutingType
of this step.Idicates whether this step is the origin of a recalculated route, and if so, which
ReroutingType
was used to determine the (new) route.Might return
null
, if this step is not the origin of a recalculated route.- Returns:
- The
ReroutingType
of this step.
-
equals
-
equalsInMovement
Compares the given step to this step, ignoring rerouting-related properties.- Parameters:
step
- The step to compare to.- Returns:
true
, if the given step is equal to this step (ignoring rerouting-related properties), otherwisefalse
.
-
hashCode
public int hashCode() -
toString
-