com.graphhopper.routing.util

Class AbstractFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

All Implemented Interfaces:

EncodedValueLookup, FlagEncoder, TurnCostEncoder

Direct Known Subclasses:

BikeCommonFlagEncoder, CarFlagEncoder, DataFlagEncoder, FootFlagEncoder

public abstract class AbstractFlagEncoder
extends Object
implements FlagEncoder

Abstract class which handles flag decoding and encoding. Every encoder should be registered to a EncodingManager to be usable. If you want the full long to be stored you need to enable this in the GraphHopperStorage.

Author:

Peter Karich, Nop

See Also:

EncodingManager

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>	absoluteBarriers
protected BooleanEncodedValue	accessEnc
protected EncodedValueLookup	encodedValueLookup
protected Set<String>	ferries
protected Set<String>	intendedValues
protected static double	LONG_TRIP_FERRY_SPEED
protected int	maxPossibleSpeed
protected Set<String>	oneways
protected Set<String>	potentialBarriers
protected PMap	properties
protected Set<String>	restrictedValues
protected List<String>	restrictions
protected BooleanEncodedValue	roundaboutEnc
protected static double	SHORT_TRIP_FERRY_SPEED
protected int	speedBits
protected double	speedDefault
protected DecimalEncodedValue	speedEncoder
protected double	speedFactor
protected static double	UNKNOWN_DURATION_FERRY_SPEED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)
	AbstractFlagEncoder(PMap properties)
	AbstractFlagEncoder(String propertiesStr)

Method Summary

Modifier and Type	Method and Description
protected double	applyMaxSpeed(ReaderWay way, double speed)
void	applyWayTags(ReaderWay way, EdgeIteratorState edge) Second parsing step.
void	createEncodedValues(List<EncodedValue> registerNewEncodedValue, String prefix, int index) Defines bits used for edge flags used for access, speed etc.
int	defineNodeBits(int index, int shift) Defines the bits for the node flags, which are currently used for barriers only.
int	defineRelationBits(int index, int shift) Defines the bits which are used for relation flags.
int	defineTurnBits(int index, int shift) Defines the bits reserved for storing turn restriction and turn cost
boolean	equals(Object obj)
protected void	flagsDefault(IntsRef edgeFlags, boolean forward, boolean backward) Sets default flags with specified access.
abstract EncodingManager.Access	getAccess(ReaderWay way) Decide whether a way is routable for a given mode of travel.
BooleanEncodedValue	getAccessEnc() This method returns the EncodedValue used for the direction-dependent access properties of this encoder.
InstructionAnnotation	getAnnotation(IntsRef edgeFlags, Translation tr)
DecimalEncodedValue	getAverageSpeedEnc() This method returns the EncodedValue used for the average speed of this encoder.
BooleanEncodedValue	getBooleanEncodedValue(String key)
ConditionalTagInspector	getConditionalTagInspector()
DecimalEncodedValue	getDecimalEncodedValue(String key)
<T extends EncodedValue> T	getEncodedValue(String key, Class<T> encodedValueType)
<T extends Enum> EnumEncodedValue<T>	getEnumEncodedValue(String key, Class<T> enumType)
protected double	getFerrySpeed(ReaderWay way) Special handling for ferry ways.
IntEncodedValue	getIntEncodedValue(String key)
double	getMaxSpeed()
protected double	getMaxSpeed(ReaderWay way)
protected String	getPropertiesString()
double	getTurnCost(long flags)
long	getTurnFlags(boolean restricted, double costs)
long	handleNodeTags(ReaderNode node) Parse tags on nodes.
abstract long	handleRelationTags(long oldRelation, ReaderRelation relation) Analyze the properties of a relation and create the routing flags for the second read step.
abstract IntsRef	handleWayTags(IntsRef edgeFlags, ReaderWay way, EncodingManager.Access access, long relationFlags) Analyze properties of a way and create the edge flags.
boolean	hasEncodedValue(String key)
int	hashCode()
protected void	init()
boolean	isBlockFords()
boolean	isRegistered()
boolean	isTurnRestricted(long flags)
static double	parseSpeed(String str)
void	setBlockByDefault(boolean blockByDefault) Should potential barriers block when no access limits are given?
void	setBlockFords(boolean blockFords)
protected void	setConditionalTagInspector(ConditionalTagInspector conditionalTagInspector)
void	setEncodedValueLookup(EncodedValueLookup encodedValueLookup)
void	setRegistered(boolean registered)
protected void	setSpeed(boolean reverse, IntsRef edgeFlags, double speed) Most use cases do not require this method.
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.

Methods inherited from class java.lang.Object

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

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

getVersion

Field Detail

restrictions

protected final List<String> restrictions

intendedValues

protected final Set<String> intendedValues

restrictedValues

protected final Set<String> restrictedValues

ferries

protected final Set<String> ferries

oneways

protected final Set<String> oneways

absoluteBarriers

protected final Set<String> absoluteBarriers

potentialBarriers

protected final Set<String> potentialBarriers

speedBits

protected final int speedBits

speedFactor

protected final double speedFactor

speedDefault

protected double speedDefault

accessEnc

protected BooleanEncodedValue accessEnc

roundaboutEnc

protected BooleanEncodedValue roundaboutEnc

speedEncoder

protected DecimalEncodedValue speedEncoder

properties

protected PMap properties

maxPossibleSpeed

protected int maxPossibleSpeed

encodedValueLookup

protected EncodedValueLookup encodedValueLookup

UNKNOWN_DURATION_FERRY_SPEED

protected static final double UNKNOWN_DURATION_FERRY_SPEED

See Also:

Constant Field Values

SHORT_TRIP_FERRY_SPEED

protected static final double SHORT_TRIP_FERRY_SPEED

See Also:

Constant Field Values

LONG_TRIP_FERRY_SPEED

protected static final double LONG_TRIP_FERRY_SPEED

See Also:

Constant Field Values

Constructor Detail

AbstractFlagEncoder

public AbstractFlagEncoder(PMap properties)

AbstractFlagEncoder

public AbstractFlagEncoder(String propertiesStr)

AbstractFlagEncoder

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

Parameters:

speedBits - specify the number of bits used for speed

speedFactor - specify the factor to multiple the stored value (can be used to increase or decrease accuracy of speed value)

maxTurnCosts - specify the maximum value used for turn costs, if this value is reached a turn is forbidden and results in costs of positive infinity.

Method Detail

init

protected void init()

isRegistered

public boolean isRegistered()

Specified by:

isRegistered in interface FlagEncoder

Returns:

true if already registered in an EncodingManager

setRegistered

public void setRegistered(boolean registered)

setBlockByDefault

public void setBlockByDefault(boolean blockByDefault)

Should potential barriers block when no access limits are given?

isBlockFords

public boolean isBlockFords()

setBlockFords

public void setBlockFords(boolean blockFords)

getConditionalTagInspector

public ConditionalTagInspector getConditionalTagInspector()

setConditionalTagInspector

protected void setConditionalTagInspector(ConditionalTagInspector conditionalTagInspector)

defineNodeBits

public int defineNodeBits(int index,
                          int shift)

Defines the bits for the node flags, which are currently used for barriers only.

Returns:

incremented shift value pointing behind the last used bit

createEncodedValues

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

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

defineRelationBits

public int defineRelationBits(int index,
                              int shift)

Defines the bits which are used for relation flags.

Returns:

incremented shift value pointing behind the last used bit

handleRelationTags

public abstract long handleRelationTags(long oldRelation,
                                        ReaderRelation relation)

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.

getAccess

public abstract EncodingManager.Access getAccess(ReaderWay way)

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

Returns:

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

handleWayTags

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

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

handleNodeTags

public long handleNodeTags(ReaderNode node)

Parse tags on nodes. Node tags can add to speed (like traffic_signals) where the value is strict negative or blocks access (like a barrier), then the value is strictly positive. This method is called in the second parsing step.

Returns:

encoded values or 0 if not blocking or no value stored

getAnnotation

public InstructionAnnotation getAnnotation(IntsRef edgeFlags,
                                           Translation tr)

Specified by:

getAnnotation in interface FlagEncoder

Returns:

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

flagsDefault

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

Sets default flags with specified access.

getMaxSpeed

public double getMaxSpeed()

Specified by:

getMaxSpeed in interface FlagEncoder

Returns:

the maximum speed in km/h

getMaxSpeed

protected double getMaxSpeed(ReaderWay way)

Returns:

-1 if no maxspeed found

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

parseSpeed

public static double parseSpeed(String str)

Returns:

the speed in km/h

applyWayTags

public void applyWayTags(ReaderWay way,
                         EdgeIteratorState edge)

Second parsing step. Invoked after splitting the edges. Currently used to offer a hook to calculate precise speed values based on elevation data stored in the specified edge.

getFerrySpeed

protected double getFerrySpeed(ReaderWay way)

Special handling for ferry ways.

defineTurnBits

public int defineTurnBits(int index,
                          int shift)

Defines the bits reserved for storing turn restriction and turn cost

Parameters:

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 flags)

Specified by:

isTurnRestricted in interface TurnCostEncoder

Returns:

true, if the turn restriction is encoded in the specified flags

getTurnCost

public double getTurnCost(long flags)

Specified by:

getTurnCost in interface TurnCostEncoder

Returns:

the costs encoded in the specified flag, if restricted it will be Double.POSITIVE_INFINITY

getTurnFlags

public long getTurnFlags(boolean restricted,
                         double costs)

Specified by:

getTurnFlags in interface TurnCostEncoder

Parameters:

restricted - true if restricted turn, equivalent to specifying 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

getAverageSpeedEnc

public final DecimalEncodedValue getAverageSpeedEnc()

Description copied from interface: FlagEncoder

This method returns the EncodedValue used for the average speed of this encoder.

Specified by:

getAverageSpeedEnc in interface FlagEncoder

getAccessEnc

public final BooleanEncodedValue getAccessEnc()

Description copied from interface: FlagEncoder

This method returns the EncodedValue used for the direction-dependent access properties of this encoder.

Specified by:

getAccessEnc in interface FlagEncoder

setSpeed

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

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.

applyMaxSpeed

protected double applyMaxSpeed(ReaderWay way,
                               double speed)

Parameters:

way - needed to retrieve tags

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

Returns:

The assumed speed.

getPropertiesString

protected String getPropertiesString()

getEncodedValue

public <T extends EncodedValue> T getEncodedValue(String key,
                                                  Class<T> encodedValueType)

Specified by:

getEncodedValue in interface EncodedValueLookup

getBooleanEncodedValue

public BooleanEncodedValue getBooleanEncodedValue(String key)

Specified by:

getBooleanEncodedValue in interface EncodedValueLookup

getIntEncodedValue

public IntEncodedValue getIntEncodedValue(String key)

Specified by:

getIntEncodedValue in interface EncodedValueLookup

getDecimalEncodedValue

public DecimalEncodedValue getDecimalEncodedValue(String key)

Specified by:

getDecimalEncodedValue in interface EncodedValueLookup

getEnumEncodedValue

public <T extends Enum> EnumEncodedValue<T> getEnumEncodedValue(String key,
                                                                Class<T> enumType)

Specified by:

getEnumEncodedValue in interface EncodedValueLookup

setEncodedValueLookup

public void setEncodedValueLookup(EncodedValueLookup encodedValueLookup)

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

hasEncodedValue

public boolean hasEncodedValue(String key)

Specified by:

hasEncodedValue in interface EncodedValueLookup