com.graphhopper.routing.weighting

Class AbstractWeighting

java.lang.Object

com.graphhopper.routing.weighting.AbstractWeighting

All Implemented Interfaces:

Weighting

Direct Known Subclasses:

CustomWeighting, FastestWeighting, ShortestWeighting

public abstract class AbstractWeighting
extends Object
implements Weighting

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanEncodedValue	accessEnc
protected DecimalEncodedValue	speedEnc

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

INFINITE_U_TURN_COSTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWeighting(BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, TurnCostProvider turnCostProvider)

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.
abstract double	calcEdgeWeight(EdgeIteratorState edgeState, boolean reverse) In most cases subclasses should only override this method to change the edge-weight.
long	calcTurnMillis(int inEdge, int viaNode, int outEdge)
double	calcTurnWeight(int inEdge, int viaNode, int outEdge)
boolean	edgeHasNoAccess(EdgeIteratorState edgeState, boolean reverse)
TurnCostProvider	getTurnCostProvider()
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

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

calcEdgeWeightWithAccess, getMinWeight, getName

Field Detail

accessEnc

protected final BooleanEncodedValue accessEnc

speedEnc

protected final DecimalEncodedValue speedEnc

Constructor Detail

AbstractWeighting

protected AbstractWeighting(BooleanEncodedValue accessEnc,
                            DecimalEncodedValue speedEnc,
                            TurnCostProvider turnCostProvider)

Method Detail

edgeHasNoAccess

public boolean edgeHasNoAccess(EdgeIteratorState edgeState,
                               boolean reverse)

Specified by:

edgeHasNoAccess in interface Weighting

Returns:

true if the edge is not accessible in the given direction. Note that when false is returned it does **not** mean the weight is finite! But when true is returned the weight must be infinite as well.

calcEdgeWeight

public abstract double calcEdgeWeight(EdgeIteratorState edgeState,
                                      boolean reverse)

In most cases subclasses should only override this method to change the edge-weight. The turn cost handling should normally be changed by passing another TurnCostProvider implementation to the constructor instead.

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.

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

calcTurnWeight

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

Specified by:

calcTurnWeight 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

getTurnCostProvider

public TurnCostProvider getTurnCostProvider()

toString

public String toString()

Overrides:

toString in class Object