com.graphhopper.routing.util

Class BikeCommonFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.BikeCommonFlagEncoder

All Implemented Interfaces:

EncodedValueLookup, FlagEncoder, TurnCostEncoder

Direct Known Subclasses:

BikeFlagEncoder, MountainBikeFlagEncoder, RacingBikeFlagEncoder

public abstract class BikeCommonFlagEncoder
extends AbstractFlagEncoder

Defines bit layout of bicycles (not motorcycles) for speed, access and relations (network).

Author:

Peter Karich, Nop, ratrun

Nested Class Summary

Nested classes/interfaces inherited from interface com.graphhopper.routing.util.TurnCostEncoder

TurnCostEncoder.NoTurnCostsEncoder

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	avoidHighwayTags
static int	K_UNPAVED Reports whether this edge is unpaved.
protected HashSet<String>	oppositeLanes
protected Set<String>	preferHighwayTags
protected static int	PUSHING_SECTION_SPEED
protected HashSet<String>	pushingSectionsHighways
protected EncodedValueOld	relationCodeEncoder
protected boolean	speedTwoDirections
protected Set<String>	unpavedSurfaceTags

Fields inherited from class com.graphhopper.routing.util.AbstractFlagEncoder

absoluteBarriers, accessEnc, encodedValueLookup, ferries, intendedValues, LONG_TRIP_FERRY_SPEED, maxPossibleSpeed, oneways, potentialBarriers, properties, restrictedValues, restrictions, roundaboutEnc, SHORT_TRIP_FERRY_SPEED, speedBits, speedDefault, speedEncoder, speedFactor, UNKNOWN_DURATION_FERRY_SPEED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BikeCommonFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)

Method Summary

Modifier and Type	Method and Description
protected double	applyMaxSpeed(ReaderWay way, double speed) Apply maxspeed: In contrast to the implementation of the AbstractFlagEncoder, we assume that we can reach the maxspeed for bicycles in case that the road type speed is higher and not just only 90%.
void	createEncodedValues(List<EncodedValue> registerNewEncodedValue, String prefix, int index) Defines bits used for edge flags used for access, speed etc.
int	defineRelationBits(int index, int shift) Defines the bits which are used for relation flags.
EncodingManager.Access	getAccess(ReaderWay way) Decide whether a way is routable for a given mode of travel.
InstructionAnnotation	getAnnotation(IntsRef edgeFlags, Translation tr)
protected int	getHighwaySpeed(String key)
int	getVersion()
protected int	handlePriority(ReaderWay way, double wayTypeSpeed, int priorityFromRelation) In this method we prefer cycleways or roads with designated bike access and avoid big roads or roads with trams or pedestrian.
long	handleRelationTags(long oldRelationFlags, ReaderRelation relation) Analyze the properties of a relation and create the routing flags for the second read step.
protected void	handleSpeed(IntsRef edgeFlags, ReaderWay way, double speed)
IntsRef	handleWayTags(IntsRef edgeFlags, ReaderWay way, EncodingManager.Access access, long relationFlags) Analyze properties of a way and create the edge flags.
void	setAvoidSpeedLimit(int limit)
protected void	setHighwaySpeed(String highway, int speed)
protected void	setSpecificClassBicycle(String subkey)
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.

Methods inherited from class com.graphhopper.routing.util.AbstractFlagEncoder

applyWayTags, defineNodeBits, defineTurnBits, equals, flagsDefault, getAccessEnc, getAverageSpeedEnc, getBooleanEncodedValue, getConditionalTagInspector, getDecimalEncodedValue, getEncodedValue, getEnumEncodedValue, getFerrySpeed, getIntEncodedValue, getMaxSpeed, getMaxSpeed, getPropertiesString, getTurnCost, getTurnFlags, handleNodeTags, hasEncoder, hashCode, init, isBlockFords, isRegistered, isTurnRestricted, parseSpeed, setBlockByDefault, setBlockFords, setConditionalTagInspector, setEncodedValueLookup, setRegistered, setSpeed

Methods inherited from class java.lang.Object

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

Field Detail

K_UNPAVED

public static final int K_UNPAVED

Reports whether this edge is unpaved.

See Also:

Constant Field Values

PUSHING_SECTION_SPEED

protected static final int PUSHING_SECTION_SPEED

See Also:

Constant Field Values

pushingSectionsHighways

protected final HashSet<String> pushingSectionsHighways

oppositeLanes

protected final HashSet<String> oppositeLanes

preferHighwayTags

protected final Set<String> preferHighwayTags

avoidHighwayTags

protected final Set<String> avoidHighwayTags

unpavedSurfaceTags

protected final Set<String> unpavedSurfaceTags

relationCodeEncoder

protected EncodedValueOld relationCodeEncoder

speedTwoDirections

protected boolean speedTwoDirections

Constructor Detail

BikeCommonFlagEncoder

protected BikeCommonFlagEncoder(int speedBits,
                                double speedFactor,
                                int maxTurnCosts)

Method Detail

getVersion

public int getVersion()

Returns:

the version of this FlagEncoder to enforce none-compatibility when new attributes are introduced

createEncodedValues

public void createEncodedValues(List<EncodedValue> registerNewEncodedValue,
                                String prefix,
                                int index)

Description copied from class: AbstractFlagEncoder

Defines bits used for edge flags used for access, speed etc.

Overrides:

createEncodedValues in class AbstractFlagEncoder

defineRelationBits

public int defineRelationBits(int index,
                              int shift)

Description copied from class: AbstractFlagEncoder

Defines the bits which are used for relation flags.

Overrides:

defineRelationBits in class AbstractFlagEncoder

Returns:

incremented shift value pointing behind the last used bit

getAccess

public EncodingManager.Access getAccess(ReaderWay way)

Description copied from class: AbstractFlagEncoder

Decide whether a way is routable for a given mode of travel. This skips some ways before handleWayTags is called.

Specified by:

getAccess in class AbstractFlagEncoder

Returns:

the encoded value to indicate if this encoder allows travel or not.

handleRelationTags

public long handleRelationTags(long oldRelationFlags,
                               ReaderRelation relation)

Description copied from class: AbstractFlagEncoder

Analyze the properties of a relation and create the routing flags for the second read step. In the pre-parsing step this method will be called to determine the useful relation tags.

Specified by:

handleRelationTags in class AbstractFlagEncoder

applyMaxSpeed

protected double applyMaxSpeed(ReaderWay way,
                               double speed)

Apply maxspeed: In contrast to the implementation of the AbstractFlagEncoder, we assume that we can reach the maxspeed for bicycles in case that the road type speed is higher and not just only 90%.

Overrides:

applyMaxSpeed in class AbstractFlagEncoder

Parameters:

way - needed to retrieve tags

speed - speed guessed e.g. from the road type or other tags

Returns:

The assumed average speed.

handleWayTags

public IntsRef handleWayTags(IntsRef edgeFlags,
                             ReaderWay way,
                             EncodingManager.Access access,
                             long relationFlags)

Description copied from class: AbstractFlagEncoder

Analyze properties of a way and create the edge flags. This method is called in the second parsing step.

Specified by:

handleWayTags in class AbstractFlagEncoder

getAnnotation

public InstructionAnnotation getAnnotation(IntsRef edgeFlags,
                                           Translation tr)

Specified by:

getAnnotation in interface FlagEncoder

Overrides:

getAnnotation in class AbstractFlagEncoder

Returns:

additional cost or warning information for an instruction like ferry or road charges.

handlePriority

protected int handlePriority(ReaderWay way,
                             double wayTypeSpeed,
                             int priorityFromRelation)

In this method we prefer cycleways or roads with designated bike access and avoid big roads or roads with trams or pedestrian.

Returns:

new priority based on priorityFromRelation and on the tags in ReaderWay.

handleSpeed

protected void handleSpeed(IntsRef edgeFlags,
                           ReaderWay way,
                           double speed)

setHighwaySpeed

protected void setHighwaySpeed(String highway,
                               int speed)

getHighwaySpeed

protected int getHighwaySpeed(String key)

supports

public boolean supports(Class<?> feature)

Description copied from interface: FlagEncoder

Returns true if the feature class is supported like TurnWeighting or PriorityWeighting. Use support(String) instead.

Specified by:

supports in interface FlagEncoder

Overrides:

supports in class AbstractFlagEncoder

setAvoidSpeedLimit

public void setAvoidSpeedLimit(int limit)

setSpecificClassBicycle

protected void setSpecificClassBicycle(String subkey)