com.graphhopper.routing.util

Class FootFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.FootFlagEncoder

All Implemented Interfaces:

FlagEncoder, TurnCostEncoder

Direct Known Subclasses:

HikeFlagEncoder

public class FootFlagEncoder
extends AbstractFlagEncoder

Defines bit layout for pedestrians (speed, access, surface, ...). Here we put a penalty on unsafe roads only. If you wish to also prefer routes due to beauty like hiking routes use the HikeFlagEncoder instead.

Author:

Peter Karich, Nop, Karl Hübner

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 HashSet<String>	sidewalksNoValues
protected HashSet<String>	sidewalkValues

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

Constructor and Description
FootFlagEncoder() Should be only instantiated via EncodingManager
FootFlagEncoder(int speedBits, double speedFactor)
FootFlagEncoder(PMap properties)
FootFlagEncoder(String propertiesStr)

Method Summary

Modifier and Type	Method and Description
long	acceptWay(ReaderWay way) Some ways are okay but not separate for pedestrians.
int	defineRelationBits(int index, int shift) Defines the bits which are used for relation flags.
int	defineTurnBits(int index, int shift) Foot flag encoder does not provide any turn cost / restrictions
int	defineWayBits(int index, int shift) Defines bits used for edge flags used for access, speed etc.
double	getDouble(long flags, int key) Returns arbitrary double value identified by the specified key.
double	getSpeed(long flags)
double	getTurnCost(long flag) Foot flag encoder does not provide any turn cost / restrictions
long	getTurnFlags(boolean restricted, double costs)
int	getVersion()
protected int	handlePriority(ReaderWay way, int priorityFromRelation)
long	handleRelationTags(ReaderRelation relation, long oldRelationFlags) Analyze the properties of a relation and create the routing flags for the second read step.
long	handleWayTags(ReaderWay way, long allowed, long relationFlags) Analyze properties of a way and create the routing flags.
boolean	isTurnRestricted(long flag) Foot flag encoder does not provide any turn cost / restrictions
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.
String	toString()

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

applyMaxSpeed, applyWayTags, defineNodeBits, equals, flagsDefault, getAnnotation, getConditionalTagInspector, getFerrySpeed, getLong, getMaxSpeed, getMaxSpeed, getPropertiesString, getReverseSpeed, handleNodeTags, hashCode, init, isAccept, isBackward, isBlockFords, isBool, isFerry, isForward, isRegistered, parseSpeed, reverseFlags, setAccess, setBlockByDefault, setBlockFords, setBool, setConditionalTagInspector, setDouble, setLong, setLowSpeed, setProperties, setRegistered, setReverseSpeed, setSpeed

Methods inherited from class java.lang.Object

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

Field Detail

sidewalkValues

protected HashSet<String> sidewalkValues

sidewalksNoValues

protected HashSet<String> sidewalksNoValues

Constructor Detail

FootFlagEncoder

public FootFlagEncoder()

Should be only instantiated via EncodingManager

FootFlagEncoder

public FootFlagEncoder(PMap properties)

FootFlagEncoder

public FootFlagEncoder(String propertiesStr)

FootFlagEncoder

public FootFlagEncoder(int speedBits,
                       double speedFactor)

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

defineTurnBits

public int defineTurnBits(int index,
                          int shift)

Foot flag encoder does not provide any turn cost / restrictions

Overrides:

defineTurnBits in class AbstractFlagEncoder

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

Returns:

incremented shift value pointing behind the last used bit

isTurnRestricted

public boolean isTurnRestricted(long flag)

Foot flag encoder does not provide any turn cost / restrictions

Specified by:

isTurnRestricted in interface TurnCostEncoder

Overrides:

isTurnRestricted in class AbstractFlagEncoder

Returns:

false

getTurnCost

public double getTurnCost(long flag)

Foot flag encoder does not provide any turn cost / restrictions

Specified by:

getTurnCost in interface TurnCostEncoder

Overrides:

getTurnCost in class AbstractFlagEncoder

Returns:

0

getTurnFlags

public long getTurnFlags(boolean restricted,
                         double costs)

Specified by:

getTurnFlags in interface TurnCostEncoder

Overrides:

getTurnFlags in class AbstractFlagEncoder

Parameters:

restricted - true if restricted turn, equivalent to specifying of costs Double.POSITIVE_INFINITY

costs - the turn costs, specify 0 or Double.POSITIVE_INFINITY if restricted == true. Only used if restricted == false.

Returns:

the encoded flags

acceptWay

public long acceptWay(ReaderWay way)

Some ways are okay but not separate for pedestrians.

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

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

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

handlePriority

protected int handlePriority(ReaderWay way,
                             int priorityFromRelation)

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

toString

public String toString()

Overrides:

toString in class Object

getSpeed

public double getSpeed(long flags)

Specified by:

getSpeed in interface FlagEncoder

Overrides:

getSpeed in class AbstractFlagEncoder

Returns:

the speed in km/h for this direction, for backward direction use getReverseSpeed