com.graphhopper.routing.weighting

Class QueryGraphWeighting

java.lang.Object

com.graphhopper.routing.weighting.QueryGraphWeighting

All Implemented Interfaces:

Weighting

public class QueryGraphWeighting
extends Object
implements Weighting

Whenever a QueryGraph is used for shortest path calculations including turn costs we need to wrap the Weighting we want to use with this class. Otherwise turn costs at virtual nodes and/or including virtual edges will not be calculated correctly.

Field Summary

Fields inherited from interface com.graphhopper.routing.weighting.Weighting

INFINITE_U_TURN_COSTS

Constructor Summary

Constructors

Constructor and Description
QueryGraphWeighting(Weighting weighting, int firstVirtualNodeId, int firstVirtualEdgeId, com.carrotsearch.hppc.IntArrayList closestEdges)

Method Summary

Modifier and Type	Method and Description
long	calcEdgeMillis(EdgeIteratorState edgeState, boolean reverse) This method calculates the time taken (in milli seconds) to travel along the specified edgeState.
double	calcEdgeWeight(EdgeIteratorState edgeState, boolean reverse) This method calculates the weight of a given EdgeIteratorState.
long	calcTurnMillis(int inEdge, int viaNode, int outEdge)
double	calcTurnWeight(int inEdge, int viaNode, int outEdge)
FlagEncoder	getFlagEncoder()
double	getMinWeight(double distance) Used only for the heuristic estimation in A*
String	getName()
boolean	hasTurnCosts() This method can be used to check whether or not this weighting returns turn costs (or if they are all zero).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryGraphWeighting

public QueryGraphWeighting(Weighting weighting,
                           int firstVirtualNodeId,
                           int firstVirtualEdgeId,
                           com.carrotsearch.hppc.IntArrayList closestEdges)

Method Detail

getMinWeight

public double getMinWeight(double distance)

Description copied from interface: Weighting

Used only for the heuristic estimation in A*

Specified by:

getMinWeight in interface Weighting

Returns:

minimal weight for the specified distance in meter. E.g. if you calculate the fastest way the return value is 'distance/max_velocity'

calcEdgeWeight

public double calcEdgeWeight(EdgeIteratorState edgeState,
                             boolean reverse)

Description copied from interface: Weighting

This method calculates the weight of a given EdgeIteratorState. E.g. a high value indicates that the edge should be avoided during shortest path search. Make sure that this method is very fast and optimized as this is called potentially millions of times for one route or a lot more for nearly any preprocessing phase.

Specified by:

calcEdgeWeight in interface Weighting

Parameters:

edgeState - the edge for which the weight should be calculated

reverse - if the specified edge is specified in reverse direction e.g. from the reverse case of a bidirectional search.

Returns:

the calculated weight with the specified velocity has to be in the range of 0 and +Infinity. Make sure your method does not return NaN which can e.g. occur for 0/0.

calcTurnWeight

public double calcTurnWeight(int inEdge,
                             int viaNode,
                             int outEdge)

Specified by:

calcTurnWeight in interface Weighting

calcEdgeMillis

public long calcEdgeMillis(EdgeIteratorState edgeState,
                           boolean reverse)

Description copied from interface: Weighting

This method calculates the time taken (in milli seconds) to travel along the specified edgeState. It is typically used for post-processing and on only a few thousand edges.

Specified by:

calcEdgeMillis in interface Weighting

calcTurnMillis

public long calcTurnMillis(int inEdge,
                           int viaNode,
                           int outEdge)

Specified by:

calcTurnMillis in interface Weighting

hasTurnCosts

public boolean hasTurnCosts()

Description copied from interface: Weighting

This method can be used to check whether or not this weighting returns turn costs (or if they are all zero). This is sometimes needed to do safety checks as not all graph algorithms can be run edge-based and might yield wrong results when turn costs are applied while running node-based.

Specified by:

hasTurnCosts in interface Weighting

getFlagEncoder

public FlagEncoder getFlagEncoder()

Specified by:

getFlagEncoder in interface Weighting

getName

public String getName()

Specified by:

getName in interface Weighting

toString

public String toString()

Overrides:

toString in class Object