com.graphhopper.routing.weighting

Interface Weighting

All Known Implementing Classes:

AbstractAdjustedWeighting, AbstractWeighting, AvoidEdgesWeighting, BlockAreaWeighting, CurvatureWeighting, FastestWeighting, GenericWeighting, PreparationWeighting, PriorityWeighting, ShortestWeighting, ShortFastestWeighting, TurnWeighting

public interface Weighting

Specifies how the best route is calculated. E.g. the fastest or shortest route.

Author:

Peter Karich

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	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 map) Returns true if the specified weighting and encoder matches to this Weighting.

Method Detail

getMinWeight

double getMinWeight(double distance)

Used only for the heuristic estimation in A*

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

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

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.

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

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. Typically used for post-processing and on only a few thousand edges.

getFlagEncoder

FlagEncoder getFlagEncoder()

getName

String getName()

matches

boolean matches(HintsMap map)

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