Path (GraphHopper Core 0.9.0 API)

java.lang.Object
- com.graphhopper.routing.Path

Direct Known Subclasses:

PathBidirRef, PathNative
```
public class Path
extends Object
```
Stores the nodes for the found path of an algorithm. It additionally needs the edgeIds to make edge determination faster and less complex as there could be several edges (u,v) especially for graphs with shortcuts.

Author:

Peter Karich, Ottavio Campana, jan soe

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Path.EdgeVisitor
The callback used in forEveryEdge.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Path.EdgeVisitor` The callback used in forEveryEdge.

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`distance`
`protected int`	`endNode`
`protected Graph`	`graph`
`protected boolean`	`reverseOrder`
`protected SPTEntry`	`sptEntry` Shortest path tree entry
`protected long`	`time`
`protected Weighting`	`weighting`

Constructor Summary

Constructors
Constructor and Description

Path(Graph graph, Weighting weighting)

Constructors
Constructor and Description
`Path(Graph graph, Weighting weighting)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addEdge(int edge)`
`List<EdgeIteratorState>`	`calcEdges()` Returns the list of all edges.
`InstructionList`	`calcInstructions(Translation tr)`
`com.carrotsearch.hppc.IntIndexedContainer`	`calcNodes()`
`PointList`	`calcPoints()` This method calculated a list of points for this path
`Path`	`extract()` Extracts the Path from the shortest-path-tree determined by sptEntry.
`String`	`getDebugInfo()`
`List<String>`	`getDescription()`
`double`	`getDistance()`
`int`	`getEdgeCount()`
`long`	`getExtractTime()`
`EdgeIteratorState`	`getFinalEdge()` Yields the final edge of the path
`long`	`getTime()`
`double`	`getWeight()` This weight will be updated during the algorithm.
`boolean`	`isFound()`
`protected void`	`processEdge(int edgeId, int adjNode, int prevEdgeId)` Calculates the distance and time of the specified edgeId.
`Path`	`setDescription(List<String> description)`
`Path`	`setDistance(double distance)`
`protected Path`	`setEndNode(int end)`
`Path`	`setFound(boolean found)`
`protected Path`	`setFromNode(int from)` We need to remember fromNode explicitly as its not saved in one edgeId of edgeIds.
`Path`	`setSPTEntry(SPTEntry sptEntry)`
`Path`	`setWeight(double w)`
`String`	`toDetailsString()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - graph
```
protected Graph graph
```
  - distance
```
protected double distance
```
  - reverseOrder
```
protected boolean reverseOrder
```
  - time
```
protected long time
```
  - sptEntry
```
protected SPTEntry sptEntry
```
    Shortest path tree entry
  - endNode
```
protected int endNode
```
  - weighting
```
protected Weighting weighting
```
- Constructor Detail
  - Path
```
public Path(Graph graph,
            Weighting weighting)
```
- Method Detail
  - getDescription
```
public List<String> getDescription()
```
    Returns:
    
    the description of this route alternative to make it meaningful for the user e.g. it displays one or two main roads of the route.
  - setDescription
```
public Path setDescription(List<String> description)
```
  - setSPTEntry
```
public Path setSPTEntry(SPTEntry sptEntry)
```
  - addEdge
```
protected void addEdge(int edge)
```
  - setEndNode
```
protected Path setEndNode(int end)
```
  - setFromNode
```
protected Path setFromNode(int from)
```
    We need to remember fromNode explicitly as its not saved in one edgeId of edgeIds.
  - getEdgeCount
```
public int getEdgeCount()
```
  - isFound
```
public boolean isFound()
```
  - setFound
```
public Path setFound(boolean found)
```
  - setDistance
```
public Path setDistance(double distance)
```
  - getDistance
```
public double getDistance()
```
    Returns:
    
    distance in meter
  - getTime
```
public long getTime()
```
    Returns:
    
    time in millis
  - getWeight
```
public double getWeight()
```
    This weight will be updated during the algorithm. The initial value is maximum double.
  - setWeight
```
public Path setWeight(double w)
```
  - extract
```
public Path extract()
```
    Extracts the Path from the shortest-path-tree determined by sptEntry.
  - getFinalEdge
```
public EdgeIteratorState getFinalEdge()
```
    Yields the final edge of the path
  - getExtractTime
```
public long getExtractTime()
```
    Returns:
    
    the time it took to extract the path in nano (!) seconds
  - getDebugInfo
```
public String getDebugInfo()
```
  - processEdge
```
protected void processEdge(int edgeId,
                           int adjNode,
                           int prevEdgeId)
```
    Calculates the distance and time of the specified edgeId. Also it adds the edgeId to the path list.
    
    Parameters:
    
    prevEdgeId - here the edge that comes before edgeId is necessary. I.e. for the reverse search we need the next edge.
  - calcEdges
```
public List<EdgeIteratorState> calcEdges()
```
    Returns the list of all edges.
  - calcNodes
```
public com.carrotsearch.hppc.IntIndexedContainer calcNodes()
```
    Returns:
    
    the uncached node indices of the tower nodes in this path.
  - calcPoints
```
public PointList calcPoints()
```
    This method calculated a list of points for this path
    
    Returns:
    
    this path its geometry
  - calcInstructions
```
public InstructionList calcInstructions(Translation tr)
```
    Returns:
    
    the list of instructions for this path.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDetailsString
```
public String toDetailsString()
```

Class Path

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

graph

distance

reverseOrder

time

sptEntry

endNode

weighting

Constructor Detail

Path

Method Detail

getDescription

setDescription

setSPTEntry

addEdge

setEndNode

setFromNode

getEdgeCount

isFound

setFound

setDistance

getDistance

getTime

getWeight

setWeight

extract

getFinalEdge

getExtractTime

getDebugInfo

processEdge

calcEdges

calcNodes

calcPoints

calcInstructions

toString

toDetailsString