com.graphhopper.routing

Class Path

java.lang.Object

com.graphhopper.routing.Path

public class Path
extends Object

This class represents the result of a shortest path calculation. It also provides methods to extract further information about the found path, like instructions etc.

Author:

Peter Karich, Ottavio Campana, jan soe, easbar

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Path(Graph graph)

Method Summary

Modifier and Type	Method and Description
Path	addDistance(double distance)
void	addEdge(int edge)
Path	addTime(long time)
List<EdgeIteratorState>	calcEdges() Returns the list of all edges.
com.carrotsearch.hppc.IntIndexedContainer	calcNodes()
PointList	calcPoints() This method calculated a list of points for this path
void	forEveryEdge(Path.EdgeVisitor visitor) Iterates over all edges in this path sorted from start to end and calls the visitor callback for every edge.
String	getDebugInfo()
List<String>	getDescription()
double	getDistance()
int	getEdgeCount()
int	getEndNode()
EdgeIteratorState	getFinalEdge() Yields the final edge of the path
int	getSize()
long	getTime()
double	getWeight() This weight will be updated during the algorithm.
boolean	isFound()
void	setDebugInfo(String debugInfo)
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	setWeight(double w)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path(Graph graph)

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)

addEdge

public void addEdge(int edge)

getEndNode

public int getEndNode()

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)

addDistance

public Path addDistance(double distance)

getDistance

public double getDistance()

Returns:

distance in meter

getTime

public long getTime()

Returns:

time in millis

addTime

public Path addTime(long time)

getWeight

public double getWeight()

This weight will be updated during the algorithm. The initial value is maximum double.

setWeight

public Path setWeight(double w)

getFinalEdge

public EdgeIteratorState getFinalEdge()

Yields the final edge of the path

setDebugInfo

public void setDebugInfo(String debugInfo)

getDebugInfo

public String getDebugInfo()

forEveryEdge

public void forEveryEdge(Path.EdgeVisitor visitor)

Iterates over all edges in this path sorted from start to end and calls the visitor callback for every edge.

Parameters:

visitor - callback to handle every edge. The edge is decoupled from the iterator and can be stored.

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:

the geometry of this path

getSize

public int getSize()

toString

public String toString()

Overrides:

toString in class Object