com.graphhopper.routing.util

Class AbstractFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

All Implemented Interfaces:

EncodedValueLookup, FlagEncoder

Direct Known Subclasses:

BikeCommonFlagEncoder, CarFlagEncoder, FootFlagEncoder, RoadsFlagEncoder

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanEncodedValue	accessEnc
protected DecimalEncodedValue	avgSpeedEnc
protected Set<String>	barriers
protected EncodedValueLookup	encodedValueLookup
protected Set<String>	ferries
protected FerrySpeedCalculator	ferrySpeedCalc
protected Set<String>	intendedValues
protected double	maxPossibleSpeed
protected Set<String>	oneways
protected Set<String>	restrictedValues
protected List<String>	restrictions
protected BooleanEncodedValue	roundaboutEnc
protected int	speedBits
protected double	speedFactor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	applyWayTags(ReaderWay way, EdgeIteratorState edge) Second parsing step.
protected void	blockFords(boolean blockFords)
protected void	blockPrivate(boolean blockPrivate)
void	createEncodedValues(List<EncodedValue> registerNewEncodedValue) Defines bits used for edge flags used for access, speed etc.
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.
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)
List<EncodedValue>	getEncodedValues()
<T extends Enum<?>> EnumEncodedValue<T>	getEnumEncodedValue(String key, Class<T> enumType)
IntEncodedValue	getIntEncodedValue(String key)
double	getMaxSpeed()
protected double	getMaxSpeed(ReaderWay way)
int	getMaxTurnCosts()
abstract String	getName()
protected String	getPropertiesString()
List<String>	getRestrictions()
StringEncodedValue	getStringEncodedValue(String key)
IntsRef	handleNodeTags(IntsRef edgeFlags, Map<String,Object> nodeTags) Updates the given edge flags based on node tags
abstract IntsRef	handleWayTags(IntsRef edgeFlags, ReaderWay way) Analyze properties of a way and create the edge flags.
boolean	hasEncodedValue(String key)
protected void	init(DateRangeParser dateRangeParser)
boolean	isBarrier(ReaderNode node)
boolean	isBlockFords()
boolean	isRegistered()
protected boolean	isValidSpeed(double speed)
protected void	setConditionalTagInspector(ConditionalTagInspector inspector)
void	setEncodedValueLookup(EncodedValueLookup encodedValueLookup)
protected void	setSpeed(boolean reverse, IntsRef edgeFlags, double speed)
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.
boolean	supportsTurnCosts()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getTransportationMode

Field Detail

intendedValues

protected final Set<String> intendedValues

restrictions

protected final List<String> restrictions

restrictedValues

protected final Set<String> restrictedValues

ferries

protected final Set<String> ferries

oneways

protected final Set<String> oneways

barriers

protected final Set<String> barriers

speedBits

protected final int speedBits

speedFactor

protected final double speedFactor

accessEnc

protected BooleanEncodedValue accessEnc

roundaboutEnc

protected BooleanEncodedValue roundaboutEnc

avgSpeedEnc

protected DecimalEncodedValue avgSpeedEnc

maxPossibleSpeed

protected double maxPossibleSpeed

encodedValueLookup

protected EncodedValueLookup encodedValueLookup

ferrySpeedCalc

protected FerrySpeedCalculator ferrySpeedCalc

Constructor Detail

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(DateRangeParser dateRangeParser)

setConditionalTagInspector

protected void setConditionalTagInspector(ConditionalTagInspector inspector)

isRegistered

public boolean isRegistered()

Specified by:

isRegistered in interface FlagEncoder

Returns:

true if already registered in an EncodingManager

isBlockFords

public boolean isBlockFords()

blockFords

protected void blockFords(boolean blockFords)

blockPrivate

protected void blockPrivate(boolean blockPrivate)

getConditionalTagInspector

public ConditionalTagInspector getConditionalTagInspector()

createEncodedValues

public void createEncodedValues(List<EncodedValue> registerNewEncodedValue)

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

handleWayTags

public abstract IntsRef handleWayTags(IntsRef edgeFlags,
                                      ReaderWay way)

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

handleNodeTags

public IntsRef handleNodeTags(IntsRef edgeFlags,
                              Map<String,Object> nodeTags)

Updates the given edge flags based on node tags

getMaxTurnCosts

public int getMaxTurnCosts()

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.

isBarrier

public boolean isBarrier(ReaderNode node)

Returns:

true if the given OSM node blocks access for this vehicle, false otherwise

getMaxSpeed

public double getMaxSpeed()

Specified by:

getMaxSpeed in interface FlagEncoder

Returns:

the maximum speed in km/h

getMaxSpeed

protected double getMaxSpeed(ReaderWay way)

Returns:

Double.NaN if no maxspeed found

isValidSpeed

protected boolean isValidSpeed(double speed)

Returns:

true if the given speed is not Double.NaN

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.

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)

getPropertiesString

protected String getPropertiesString()

getEncodedValues

public List<EncodedValue> getEncodedValues()

Specified by:

getEncodedValues in interface EncodedValueLookup

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

getStringEncodedValue

public StringEncodedValue getStringEncodedValue(String key)

Specified by:

getStringEncodedValue in interface EncodedValueLookup

setEncodedValueLookup

public void setEncodedValueLookup(EncodedValueLookup encodedValueLookup)

supportsTurnCosts

public boolean supportsTurnCosts()

Specified by:

supportsTurnCosts in interface FlagEncoder

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

getRestrictions

public final List<String> getRestrictions()

getName

public abstract String getName()

toString

public String toString()

Overrides:

toString in class Object