com.graphhopper.routing.util

Class DataFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.DataFlagEncoder

All Implemented Interfaces:

EncodedValueLookup, 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, 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

Constructor and Description
DataFlagEncoder()
DataFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)
DataFlagEncoder(PMap properties)

Method Summary

Modifier and Type	Method and Description
void	createEncodedValues(List<EncodedValue> registerNewEncodedValue, String prefix, int index) Defines bits used for edge flags used for access, speed etc.
DataFlagEncoder.WeightingConfig	createWeightingConfig(PMap pMap) This method creates a Config map out of the PMap.
protected void	flagsDefault(IntsRef edgeFlags, boolean forward, boolean backward) Sets default flags with specified access.
EncodingManager.Access	getAccess(ReaderWay way) Decide whether a way is routable for a given mode of travel.
int	getAccessType(String accessStr)
SpatialRule.Access	getAccessValue(IntsRef flags)
InstructionAnnotation	getAnnotation(IntsRef 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()
int	getSpatialId(IntsRef flags) This method returns the spatialId stored in the specified flags or -1 if not enabled for this encoder.
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(long oldRelationFlags, ReaderRelation relation) Analyze the properties of a relation and create the routing flags for the second read step.
IntsRef	handleWayTags(IntsRef edgeFlags, ReaderWay way, EncodingManager.Access access, long relationFlags) Analyze properties of a way and create the edge flags.
boolean	isStoreHeight()
boolean	isStoreWeight()
boolean	isStoreWidth()
boolean	isTransportModeBridge(EdgeIteratorState edge)
boolean	isTransportModeFord(IntsRef edgeFlags)
boolean	isTransportModeTunnel(EdgeIteratorState edge)
void	setSpatialId(IntsRef flags, int id) This method set the spatial ID (e.g.
DataFlagEncoder	setSpatialRuleLookup(SpatialRuleLookup spatialRuleLookup)
protected void	setSpeed(boolean reverse, IntsRef edgeFlags, double speed) Most use cases do not require this method.
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, getAccessEnc, getAverageSpeedEnc, getBooleanEncodedValue, getConditionalTagInspector, getDecimalEncodedValue, getEncodedValue, getFerrySpeed, getIntEncodedValue, getObjectEncodedValue, getTurnCost, getTurnFlags, handleNodeTags, hasEncoder, hashCode, init, isBlockFords, isRegistered, isTurnRestricted, parseSpeed, setBlockByDefault, setBlockFords, setConditionalTagInspector, setEncodedValueLookup, 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

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

flagsDefault

protected void flagsDefault(IntsRef edgeFlags,
                            boolean forward,
                            boolean backward)

Description copied from class: AbstractFlagEncoder

Sets default flags with specified access.

Overrides:

flagsDefault in class AbstractFlagEncoder

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

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.

getAccessValue

public SpatialRule.Access getAccessValue(IntsRef flags)

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

stringToTons

public static double stringToTons(String value)

stringToMeter

public static double stringToMeter(String value)

getSpatialId

public int getSpatialId(IntsRef flags)

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

setSpatialId

public void setSpatialId(IntsRef 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

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(IntsRef edgeFlags)

getTransportModeAsString

public String getTransportModeAsString(EdgeIteratorState edge)

getTransportModeMap

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

getAccessType

public int getAccessType(String accessStr)

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)

setSpeed

protected void setSpeed(boolean reverse,
                        IntsRef edgeFlags,
                        double speed)

Description copied from class: AbstractFlagEncoder

Most use cases do not require this method. Will still keep it accessible so that one can disable it until the averageSpeedEncodedValue is moved out of the FlagEncoder.

Overrides:

setSpeed in class AbstractFlagEncoder

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. Use support(String) instead.

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(IntsRef 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.