com.graphhopper.routing.util

Class BikeCommonFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.BikeCommonFlagEncoder

All Implemented Interfaces:

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 EncodedValue	relationCodeEncoder
protected Set<String>	unpavedSurfaceTags

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

absoluteBarriers, acceptBit, backwardBit, directionBitMask, edgeInExplorer, edgeOutExplorer, ferries, ferryBit, forwardBit, intendedValues, K_BACKWARD, K_FORWARD, LONG_TRIP_FERRY_SPEED, maxPossibleSpeed, oneways, potentialBarriers, properties, restrictedValues, restrictions, roundaboutBit, SHORT_TRIP_FERRY_SPEED, speedBits, speedEncoder, speedFactor, UNKNOWN_DURATION_FERRY_SPEED

Fields inherited from interface com.graphhopper.routing.util.FlagEncoder

K_ROUNDABOUT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	acceptWay(ReaderWay way) Decide whether a way is routable for a given mode of travel.
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%.
int	defineRelationBits(int index, int shift) Defines the bits which are used for relation flags.
int	defineWayBits(int index, int shift) Defines bits used for edge flags used for access, speed etc.
InstructionAnnotation	getAnnotation(long flags, Translation tr)
double	getDouble(long flags, int key) Returns arbitrary double value identified by the specified key.
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(ReaderRelation relation, long oldRelationFlags) Analyze the properties of a relation and create the routing flags for the second read step.
protected long	handleSpeed(ReaderWay way, double speed, long encoded)
long	handleWayTags(ReaderWay way, long allowed, long relationFlags) Analyze properties of a way and create the routing flags.
boolean	isBool(long flags, int key) Returns arbitrary boolean value identified by the specified key.
void	setAvoidSpeedLimit(int limit)
long	setBool(long flags, int key, boolean value)
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, getConditionalTagInspector, getFerrySpeed, getLong, getMaxSpeed, getMaxSpeed, getPropertiesString, getReverseSpeed, getSpeed, getTurnCost, getTurnFlags, handleNodeTags, hashCode, init, isAccept, isBackward, isBlockFords, isFerry, isForward, isRegistered, isTurnRestricted, parseSpeed, reverseFlags, setAccess, setBlockByDefault, setBlockFords, setConditionalTagInspector, setDouble, setLong, setLowSpeed, setProperties, setRegistered, setReverseSpeed, 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 EncodedValue relationCodeEncoder

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

defineWayBits

public int defineWayBits(int index,
                         int shift)

Description copied from class: AbstractFlagEncoder

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

Overrides:

defineWayBits in class AbstractFlagEncoder

shift - bit offset for the first bit used by this encoder

Returns:

incremented shift value pointing behind the last used bit

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

acceptWay

public long acceptWay(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:

acceptWay in class AbstractFlagEncoder

Returns:

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

handleRelationTags

public long handleRelationTags(ReaderRelation relation,
                               long oldRelationFlags)

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 long handleWayTags(ReaderWay way,
                          long allowed,
                          long relationFlags)

Description copied from class: AbstractFlagEncoder

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

Specified by:

handleWayTags in class AbstractFlagEncoder

getAnnotation

public InstructionAnnotation getAnnotation(long flags,
                                           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.

setBool

public long setBool(long flags,
                    int key,
                    boolean value)

Specified by:

setBool in interface FlagEncoder

Overrides:

setBool in class AbstractFlagEncoder

isBool

public boolean isBool(long flags,
                      int key)

Description copied from interface: FlagEncoder

Returns arbitrary boolean value identified by the specified key.

Specified by:

isBool in interface FlagEncoder

Overrides:

isBool in class AbstractFlagEncoder

getDouble

public double getDouble(long flags,
                        int key)

Description copied from interface: FlagEncoder

Returns arbitrary double value identified by the specified key. E.g. can be used to return the maximum width or height allowed for an edge.

Specified by:

getDouble in interface FlagEncoder

Overrides:

getDouble in class AbstractFlagEncoder

handleSpeed

protected long handleSpeed(ReaderWay way,
                           double speed,
                           long encoded)

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.

Specified by:

supports in interface FlagEncoder

Overrides:

supports in class AbstractFlagEncoder

setAvoidSpeedLimit

public void setAvoidSpeedLimit(int limit)

setSpecificClassBicycle

protected void setSpecificClassBicycle(String subkey)