com.graphhopper.routing.weighting

Class FastestWeighting

java.lang.Object

com.graphhopper.routing.weighting.AbstractWeighting

com.graphhopper.routing.weighting.FastestWeighting

All Implemented Interfaces:

Weighting

Direct Known Subclasses:

PriorityWeighting, ShortFastestWeighting

public class FastestWeighting
extends AbstractWeighting

Calculates the fastest route with the specified vehicle (VehicleEncoder). Calculates the weight in seconds.

Author:

Peter Karich

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESTINATION_FACTOR
static String	PRIVATE_FACTOR
protected static double	SPEED_CONV Converting to seconds is not necessary but makes adding other penalties easier (e.g.

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

accessEnc, speedEnc

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

INFINITE_U_TURN_COSTS

Constructor Summary

Constructors

Constructor and Description
FastestWeighting(BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc)
FastestWeighting(BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc, EnumEncodedValue<RoadAccess> roadAccessEnc, PMap map, TurnCostProvider turnCostProvider)
FastestWeighting(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.
double	calcEdgeWeight(EdgeIteratorState edgeState, boolean reverse) In most cases subclasses should only override this method to change the edge-weight.
double	getMinWeight(double distance) Used only for the heuristic estimation in A*
String	getName()

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

calcTurnMillis, calcTurnWeight, edgeHasNoAccess, getTurnCostProvider, hasTurnCosts, 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

Field Detail

DESTINATION_FACTOR

public static String DESTINATION_FACTOR

PRIVATE_FACTOR

public static String PRIVATE_FACTOR

SPEED_CONV

protected static final double SPEED_CONV

Converting to seconds is not necessary but makes adding other penalties easier (e.g. turn costs or traffic light costs etc)

See Also:

Constant Field Values

Constructor Detail

FastestWeighting

public FastestWeighting(BooleanEncodedValue accessEnc,
                        DecimalEncodedValue speedEnc)

FastestWeighting

public FastestWeighting(BooleanEncodedValue accessEnc,
                        DecimalEncodedValue speedEnc,
                        TurnCostProvider turnCostProvider)

FastestWeighting

public FastestWeighting(BooleanEncodedValue accessEnc,
                        DecimalEncodedValue speedEnc,
                        EnumEncodedValue<RoadAccess> roadAccessEnc,
                        PMap map,
                        TurnCostProvider turnCostProvider)

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'

calcEdgeWeight

public double calcEdgeWeight(EdgeIteratorState edgeState,
                             boolean reverse)

Description copied from class: AbstractWeighting

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

Specified by:

calcEdgeWeight in class AbstractWeighting

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

Overrides:

calcEdgeMillis in class AbstractWeighting

getName

public String getName()