com.graphhopper.routing.weighting

Class GenericWeighting

java.lang.Object

com.graphhopper.routing.weighting.AbstractWeighting

com.graphhopper.routing.weighting.GenericWeighting

All Implemented Interfaces:

Weighting

public class GenericWeighting
extends AbstractWeighting

Calculates the best route according to a configurable weighting.

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
protected int	accessType
protected DataFlagEncoder	gEncoder
protected double	headingPenalty
protected long	headingPenaltyMillis
protected double	height
static String	HEIGHT_LIMIT
protected double	maxSpeed
protected static double	SPEED_CONV Convert to milliseconds for correct calcMillis.
protected int	uncertainAccessiblePenalty
protected double	weight
static String	WEIGHT_LIMIT
protected DataFlagEncoder.WeightingConfig	weightingConfig
protected double	width
static String	WIDTH_LIMIT

Fields inherited from class com.graphhopper.routing.weighting.AbstractWeighting

flagEncoder

Constructor Summary

Constructors

Constructor and Description
GenericWeighting(DataFlagEncoder encoder, PMap hintsMap)

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.
double	getMinWeight(double distance) Used only for the heuristic estimation in A*
String	getName()

Methods inherited from class com.graphhopper.routing.weighting.AbstractWeighting

equals, getFlagEncoder, hashCode, matches, toString, weightingToFileName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HEIGHT_LIMIT

public static final String HEIGHT_LIMIT

See Also:

Constant Field Values

WEIGHT_LIMIT

public static final String WEIGHT_LIMIT

See Also:

Constant Field Values

WIDTH_LIMIT

public static final String WIDTH_LIMIT

See Also:

Constant Field Values

SPEED_CONV

protected static final double SPEED_CONV

Convert to milliseconds for correct calcMillis.

See Also:

Constant Field Values

headingPenalty

protected final double headingPenalty

headingPenaltyMillis

protected final long headingPenaltyMillis

maxSpeed

protected final double maxSpeed

gEncoder

protected final DataFlagEncoder gEncoder

weightingConfig

protected final DataFlagEncoder.WeightingConfig weightingConfig

accessType

protected final int accessType

uncertainAccessiblePenalty

protected final int uncertainAccessiblePenalty

See Also:

Constant Field Values

height

protected final double height

weight

protected final double weight

width

protected final double width

Constructor Detail

GenericWeighting

public GenericWeighting(DataFlagEncoder encoder,
                        PMap hintsMap)

Method Detail

getMinWeight

public double getMinWeight(double distance)

Description copied from interface: Weighting

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

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.

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

Overrides:

calcMillis in class AbstractWeighting

getName

public String getName()