com.graphhopper.routing.util

Class DataFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.DataFlagEncoder

All Implemented Interfaces:

FlagEncoder, TurnCostEncoder

public class DataFlagEncoder
extends AbstractFlagEncoder

This encoder tries to store all way information into a 32 or 64bit value. Later extendable to multiple ints or bytes. The assumption is that edge.getFlags is cheap and can be later replaced by e.g. one or more (cheap) calls of edge.getData(index).

Currently limited to motor vehicle but later could handle different modes like foot or bike too.

Author:

Peter Karich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataFlagEncoder.WeightingConfig

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

TurnCostEncoder.NoTurnCostsEncoder

Field Summary

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
DataFlagEncoder()
DataFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)
DataFlagEncoder(PMap properties)

Method Summary

Modifier and Type	Method and Description
long	acceptWay(ReaderWay way) Decide whether a way is routable for a given mode of travel.
DataFlagEncoder.WeightingConfig	createWeightingConfig(PMap pMap) This method creates a Config map out of the PMap.
int	defineWayBits(int index, int shift) Defines bits used for edge flags used for access, speed etc.
long	flagsDefault(boolean forward, boolean backward) Sets default flags with specified access.
int	getAccessType(String accessStr)
AccessValue	getAccessValue(long flags)
InstructionAnnotation	getAnnotation(long flags, Translation tr)
double	getHeight(EdgeIteratorState edge)
int	getHighway(EdgeIteratorState edge)
String	getHighwayAsString(EdgeIteratorState edge) Do not use within weighting as this is suboptimal from performance point of view.
double	getMaxPossibleSpeed()
double	getMaxSpeed()
double	getMaxspeed(EdgeIteratorState edge, int accessType, boolean reverse)
protected double	getMaxSpeed(ReaderWay way)
protected String	getPropertiesString()
double	getReverseSpeed(long flags)
int	getSpatialId(long flags) This method returns the spatialId stored in the specified flags or -1 if not enabled for this encoder.
double	getSpeed(long flags)
int	getSurface(EdgeIteratorState edge)
String	getSurfaceAsString(EdgeIteratorState edge)
int	getTransportMode(EdgeIteratorState edge)
String	getTransportModeAsString(EdgeIteratorState edge)
double[]	getTransportModeMap(Map<String,Double> map)
int	getVersion()
double	getWeight(EdgeIteratorState edge)
double	getWidth(EdgeIteratorState edge)
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	isBackward(EdgeIteratorState edge, int accessType)
boolean	isBackward(long flags) Reports whether the edge is available in backward direction (i.e.
boolean	isForward(EdgeIteratorState edge, int accessType)
boolean	isForward(long flags) Reports whether the edge is available in forward direction (i.e.
boolean	isRoundabout(EdgeIteratorState edge)
boolean	isStoreHeight()
boolean	isStoreWeight()
boolean	isStoreWidth()
boolean	isTransportModeBridge(EdgeIteratorState edge)
boolean	isTransportModeFord(long flags)
boolean	isTransportModeTunnel(EdgeIteratorState edge)
long	reverseFlags(long flags) Swapping directions means swapping bits which are dependent on the direction of an edge like the access bits.
long	setAccess(long flags, boolean forward, boolean backward) Sets the access of the edge.
protected long	setLowSpeed(long flags, double speed, boolean reverse)
long	setProperties(double speed, boolean forward, boolean backward) Sets speed and access properties.
long	setReverseSpeed(long flags, double speed) Sets the reverse speed in the flags.
long	setSpatialId(long flags, int id) This method set the spatial ID (e.g.
DataFlagEncoder	setSpatialRuleLookup(SpatialRuleLookup spatialRuleLookup)
long	setSpeed(long flags, double speed) Sets the speed in km/h.
DataFlagEncoder	setStoreHeight(boolean storeHeight)
DataFlagEncoder	setStoreWeight(boolean storeWeight)
DataFlagEncoder	setStoreWidth(boolean storeWidth)
static double	stringToMeter(String value)
static double	stringToTons(String value)
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, defineRelationBits, defineTurnBits, equals, getConditionalTagInspector, getDouble, getFerrySpeed, getLong, getTurnCost, getTurnFlags, handleNodeTags, hashCode, init, isAccept, isBlockFords, isBool, isFerry, isRegistered, isTurnRestricted, parseSpeed, setBlockByDefault, setBlockFords, setBool, setConditionalTagInspector, setDouble, setLong, setRegistered

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFlagEncoder

public DataFlagEncoder()

DataFlagEncoder

public DataFlagEncoder(PMap properties)

DataFlagEncoder

public DataFlagEncoder(int speedBits,
                       double speedFactor,
                       int maxTurnCosts)

Method Detail

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

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

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.

getAccessValue

public AccessValue getAccessValue(long flags)

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

stringToTons

public static double stringToTons(String value)

stringToMeter

public static double stringToMeter(String value)

getSpatialId

public int getSpatialId(long flags)

This method returns the spatialId stored in the specified flags or -1 if not enabled for this encoder.

setSpatialId

public long setSpatialId(long flags,
                         int id)

This method set the spatial ID (e.g. country ID) of the specified flags to the specified id. Fetch the unique spatial ID via spatialRuleLookup.lookup().getSpatialId

reverseFlags

public long reverseFlags(long flags)

Description copied from class: AbstractFlagEncoder

Swapping directions means swapping bits which are dependent on the direction of an edge like the access bits. But also direction dependent speed values should be swapped too. Keep in mind that this method is performance critical!

Overrides:

reverseFlags in class AbstractFlagEncoder

getHighway

public int getHighway(EdgeIteratorState edge)

getHighwayAsString

public String getHighwayAsString(EdgeIteratorState edge)

Do not use within weighting as this is suboptimal from performance point of view.

getSurface

public int getSurface(EdgeIteratorState edge)

getSurfaceAsString

public String getSurfaceAsString(EdgeIteratorState edge)

getTransportMode

public int getTransportMode(EdgeIteratorState edge)

isTransportModeTunnel

public boolean isTransportModeTunnel(EdgeIteratorState edge)

isTransportModeBridge

public boolean isTransportModeBridge(EdgeIteratorState edge)

isTransportModeFord

public boolean isTransportModeFord(long flags)

getTransportModeAsString

public String getTransportModeAsString(EdgeIteratorState edge)

getTransportModeMap

public double[] getTransportModeMap(Map<String,Double> map)

isRoundabout

public boolean isRoundabout(EdgeIteratorState edge)

getAccessType

public int getAccessType(String accessStr)

isForward

public final boolean isForward(EdgeIteratorState edge,
                               int accessType)

isForward

public final boolean isForward(long flags)

Description copied from interface: FlagEncoder

Reports whether the edge is available in forward direction (i.e. from base node to adj node) for a certain vehicle.

Specified by:

isForward in interface FlagEncoder

Overrides:

isForward in class AbstractFlagEncoder

isBackward

public final boolean isBackward(EdgeIteratorState edge,
                                int accessType)

isBackward

public final boolean isBackward(long flags)

Description copied from interface: FlagEncoder

Reports whether the edge is available in backward direction (i.e. from adj node to base node) for a certain vehicle.

Specified by:

isBackward in interface FlagEncoder

Overrides:

isBackward in class AbstractFlagEncoder

getMaxspeed

public double getMaxspeed(EdgeIteratorState edge,
                          int accessType,
                          boolean reverse)

getHeight

public double getHeight(EdgeIteratorState edge)

getWeight

public double getWeight(EdgeIteratorState edge)

getWidth

public double getWidth(EdgeIteratorState edge)

flagsDefault

public long flagsDefault(boolean forward,
                         boolean backward)

Description copied from class: AbstractFlagEncoder

Sets default flags with specified access.

Overrides:

flagsDefault in class AbstractFlagEncoder

setAccess

public long setAccess(long flags,
                      boolean forward,
                      boolean backward)

Description copied from interface: FlagEncoder

Sets the access of the edge.

Specified by:

setAccess in interface FlagEncoder

Overrides:

setAccess in class AbstractFlagEncoder

Returns:

modified flags

setSpeed

public long setSpeed(long flags,
                     double speed)

Description copied from interface: FlagEncoder

Sets the speed in km/h.

Specified by:

setSpeed in interface FlagEncoder

Overrides:

setSpeed in class AbstractFlagEncoder

Returns:

modified setProperties

setLowSpeed

protected long setLowSpeed(long flags,
                           double speed,
                           boolean reverse)

Overrides:

setLowSpeed in class AbstractFlagEncoder

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

setReverseSpeed

public long setReverseSpeed(long flags,
                            double speed)

Description copied from interface: FlagEncoder

Sets the reverse speed in the flags.

Specified by:

setReverseSpeed in interface FlagEncoder

Overrides:

setReverseSpeed in class AbstractFlagEncoder

getReverseSpeed

public double getReverseSpeed(long flags)

Specified by:

getReverseSpeed in interface FlagEncoder

Overrides:

getReverseSpeed in class AbstractFlagEncoder

Returns:

the speed of the reverse direction in km/h

setProperties

public long setProperties(double speed,
                          boolean forward,
                          boolean backward)

Description copied from interface: FlagEncoder

Sets speed and access properties.

Specified by:

setProperties in interface FlagEncoder

Overrides:

setProperties in class AbstractFlagEncoder

Returns:

created flags

getMaxSpeed

protected double getMaxSpeed(ReaderWay way)

Overrides:

getMaxSpeed in class AbstractFlagEncoder

Returns:

-1 if no maxspeed found

getMaxSpeed

public double getMaxSpeed()

Specified by:

getMaxSpeed in interface FlagEncoder

Overrides:

getMaxSpeed in class AbstractFlagEncoder

Returns:

the maximum speed in km/h

getMaxPossibleSpeed

public double getMaxPossibleSpeed()

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

setStoreHeight

public DataFlagEncoder setStoreHeight(boolean storeHeight)

isStoreHeight

public boolean isStoreHeight()

setStoreWeight

public DataFlagEncoder setStoreWeight(boolean storeWeight)

isStoreWeight

public boolean isStoreWeight()

setStoreWidth

public DataFlagEncoder setStoreWidth(boolean storeWidth)

isStoreWidth

public boolean isStoreWidth()

setSpatialRuleLookup

public DataFlagEncoder setSpatialRuleLookup(SpatialRuleLookup spatialRuleLookup)

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.

getPropertiesString

protected String getPropertiesString()

Overrides:

getPropertiesString in class AbstractFlagEncoder

getVersion

public int getVersion()

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

createWeightingConfig

public DataFlagEncoder.WeightingConfig createWeightingConfig(PMap pMap)

This method creates a Config map out of the PMap. Later on this conversion should not be necessary when we read JSON.