com.graphhopper.routing.weighting

Class TurnWeighting

java.lang.Object

com.graphhopper.routing.weighting.TurnWeighting

All Implemented Interfaces:

Weighting

public class TurnWeighting
extends Object
implements Weighting

Provides methods to retrieve turn costs for a specific turn.

Author:

Karl Hübner, Peter Karich

Constructor Summary

Constructors

Constructor and Description
TurnWeighting(Weighting superWeighting, TurnCostExtension turnCostExt)

Method Summary

Modifier and Type	Method and Description
long	calcMillis(EdgeIteratorState edgeState, boolean reverse, int prevOrNextEdgeId) This method calculates the time taken (in milli seconds) for the specified edgeState and optionally include the turn costs (in seconds) of the previous (or next) edgeId via prevOrNextEdgeId.
double	calcTurnWeight(int edgeFrom, int nodeVia, int edgeTo) This method calculates the turn weight separately.
double	calcWeight(EdgeIteratorState edgeState, boolean reverse, int prevOrNextEdgeId) This method calculates the weighting a certain edgeState should be associated.
FlagEncoder	getFlagEncoder()
double	getMinWeight(double distance) Used only for the heuristic estimation in A*
String	getName()
boolean	matches(HintsMap weightingMap) Returns true if the specified weighting and encoder matches to this Weighting.
TurnWeighting	setDefaultUTurnCost(double costInSeconds) Set the default cost for an u-turn in seconds.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TurnWeighting

public TurnWeighting(Weighting superWeighting,
                     TurnCostExtension turnCostExt)

Parameters:

turnCostExt - the turn cost storage to be used

Method Detail

setDefaultUTurnCost

public TurnWeighting setDefaultUTurnCost(double costInSeconds)

Set the default cost for an u-turn in seconds. Default is 40s. Should be that high to avoid 'tricking' other turn costs or restrictions.

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'

calcWeight

public double calcWeight(EdgeIteratorState edgeState,
                         boolean reverse,
                         int prevOrNextEdgeId)

Description copied from interface: Weighting

This method calculates the weighting a certain edgeState should be associated. E.g. a high value indicates that the edge should be avoided. 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:

calcWeight 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.

prevOrNextEdgeId - if reverse is false this has to be the previous edgeId, if true it has to be the next edgeId in the direction from start to end.

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.

calcMillis

public long calcMillis(EdgeIteratorState edgeState,
                       boolean reverse,
                       int prevOrNextEdgeId)

Description copied from interface: Weighting

This method calculates the time taken (in milli seconds) for the specified edgeState and optionally include the turn costs (in seconds) of the previous (or next) edgeId via prevOrNextEdgeId. Typically used for post-processing and on only a few thousand edges.

Specified by:

calcMillis in interface Weighting

calcTurnWeight

public double calcTurnWeight(int edgeFrom,
                             int nodeVia,
                             int edgeTo)

This method calculates the turn weight separately.

getFlagEncoder

public FlagEncoder getFlagEncoder()

Specified by:

getFlagEncoder in interface Weighting

matches

public boolean matches(HintsMap weightingMap)

Description copied from interface: Weighting

Returns true if the specified weighting and encoder matches to this Weighting.

Specified by:

matches in interface Weighting

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Specified by:

getName in interface Weighting