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 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

      @Nullable public Path getPath()
      Returns the path to travel.
      Returns:
      The path to travel. May be null if the vehicle does not really have to move.

    • getSourcePoint

      @Nullable public Point 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

      @Nonnull public Point getDestinationPoint()
      Returns the point that is reached by travelling the path.
      Returns:
      The point that is reached by travelling the path.

    • getVehicleOrientation

      @Nonnull public Vehicle.Orientation 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, otherwise false.

    • getReroutingType

      @Nullable public ReroutingType getReroutingType()
      Returns the ReroutingType 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

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • equalsInMovement

      public boolean equalsInMovement​(Route.Step step)
      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), otherwise false.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object