Package org.opentcs.components.kernel.routing

# Class Edge

java.lang.Object
org.opentcs.components.kernel.routing.Edge

    public class Edge
    extends java.lang.Object

A wrapper for `Path`s that can be used to build routing graphs.

- ## Constructor Summary

  Constructors
  Constructor | Description
  --- | ---
  `Edge​(Path modelPath, boolean travellingReverse)` | Creates a new instance.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `Path` | `getPath()` | Returns the path in the model that is traversed on this edge.
  `boolean` | `isTravellingReverse()` | Indicates whether the path is travelled in reverse direction.
  `java.lang.String` | `toString()` |

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### Edge

    public Edge​(@Nonnull Path modelPath, boolean travellingReverse)
    Creates a new instance.
    Parameters:
      `modelPath` - The path in the model that is traversed on this edge.
      `travellingReverse` - Whether the path is travelled in reverse direction.

- ## Method Details

  - ### getPath

    public Path getPath()
    Returns the path in the model that is traversed on this edge.
    Returns:
      The path in the model that is traversed on this edge.

  - ### isTravellingReverse

    public boolean isTravellingReverse()
    Indicates whether the path is travelled in reverse direction.
    Returns:
      Whether the path is travelled in reverse direction.

  - ### toString

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