com.graphhopper

Class PathWrapper

java.lang.Object

com.graphhopper.PathWrapper

public class PathWrapper
extends Object

This class holds the data like points and instructions of a Path.

Author:

Peter Karich

Constructor Summary

Constructors

Constructor and Description
PathWrapper()

Method Summary

Modifier and Type	Method and Description
PathWrapper	addDebugInfo(String debugInfo)
PathWrapper	addError(Throwable error)
PathWrapper	addErrors(List<Throwable> errors)
void	addPathDetails(Map<String,List<PathDetail>> details) Adds the given PathDetails to the existing ones.
BBox	calcBBox2D() Calculates the 2D bounding box of this route
double	getAscend() This method returns the total elevation change (going upwards) in meter.
String	getDebugInfo()
double	getDescend() This method returns the total elevation change (going downwards) in meter.
List<String>	getDescription()
double	getDistance() This method returns the distance of the path.
List<Throwable>	getErrors()
BigDecimal	getFare()
InstructionList	getInstructions()
List<Trip.Leg>	getLegs()
int	getNumChanges()
Map<String,List<PathDetail>>	getPathDetails()
PointList	getPoints() This method returns all points on the path.
double	getRouteWeight() This method returns a double value which is better than the time for comparison of routes but only if you know what you are doing, e.g.
long	getTime()
PointList	getWaypoints() This method returns the input points snapped to the road network.
boolean	hasErrors()
boolean	isImpossible()
static void	merge(List<PathDetail> pathDetails, List<PathDetail> otherDetails) Merges otherDetails into the pathDetails.
PathWrapper	setAscend(double ascend)
PathWrapper	setDescend(double descend)
PathWrapper	setDescription(List<String> names)
PathWrapper	setDistance(double distance)
void	setFare(BigDecimal fare)
void	setImpossible(boolean impossible)
void	setInstructions(InstructionList instructions)
void	setNumChanges(int numChanges)
PathWrapper	setPoints(PointList points)
PathWrapper	setRouteWeight(double weight)
PathWrapper	setTime(long timeInMillis)
void	setWaypoints(PointList wpList) This method initializes this path with the snapped input points.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PathWrapper

public PathWrapper()

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 PathWrapper setDescription(List<String> names)

addDebugInfo

public PathWrapper addDebugInfo(String debugInfo)

getDebugInfo

public String getDebugInfo()

getPoints

public PointList getPoints()

This method returns all points on the path. Keep in mind that calculating the distance from these points might yield different results compared to getDistance as points could have been simplified on import or after querying.

setPoints

public PathWrapper setPoints(PointList points)

getWaypoints

public PointList getWaypoints()

This method returns the input points snapped to the road network.

setWaypoints

public void setWaypoints(PointList wpList)

This method initializes this path with the snapped input points.

getDistance

public double getDistance()

This method returns the distance of the path. Always prefer this method over getPoints().calcDistance

Returns:

distance in meter

setDistance

public PathWrapper setDistance(double distance)

getAscend

public double getAscend()

This method returns the total elevation change (going upwards) in meter.

Returns:

ascend in meter

setAscend

public PathWrapper setAscend(double ascend)

getDescend

public double getDescend()

This method returns the total elevation change (going downwards) in meter.

Returns:

decline in meter

setDescend

public PathWrapper setDescend(double descend)

getTime

public long getTime()

Returns:

time in millis

setTime

public PathWrapper setTime(long timeInMillis)

getRouteWeight

public double getRouteWeight()

This method returns a double value which is better than the time for comparison of routes but only if you know what you are doing, e.g. only to compare routes gained with the same query parameters like vehicle.

setRouteWeight

public PathWrapper setRouteWeight(double weight)

calcBBox2D

public BBox calcBBox2D()

Calculates the 2D bounding box of this route

toString

public String toString()

Overrides:

toString in class Object

getInstructions

public InstructionList getInstructions()

setInstructions

public void setInstructions(InstructionList instructions)

addPathDetails

public void addPathDetails(Map<String,List<PathDetail>> details)

Adds the given PathDetails to the existing ones. If there are already PathDetails set, the number details has to be equal to details.

Parameters:

details - The PathDetails to add

merge

public static void merge(List<PathDetail> pathDetails,
                         List<PathDetail> otherDetails)

Merges otherDetails into the pathDetails.

This method makes sure that Entry list around via points are merged correctly. See #1091 and the misplaced PathDetail after waypoints.

getPathDetails

public Map<String,List<PathDetail>> getPathDetails()

hasErrors

public boolean hasErrors()

Returns:

true if this alternative response contains one or more errors

getErrors

public List<Throwable> getErrors()

addError

public PathWrapper addError(Throwable error)

addErrors

public PathWrapper addErrors(List<Throwable> errors)

setNumChanges

public void setNumChanges(int numChanges)

getNumChanges

public int getNumChanges()

getLegs

public List<Trip.Leg> getLegs()

setFare

public void setFare(BigDecimal fare)

getFare

public BigDecimal getFare()

isImpossible

public boolean isImpossible()

setImpossible

public void setImpossible(boolean impossible)