com.graphhopper.routing.util

Class CarFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.CarFlagEncoder

All Implemented Interfaces:

FlagEncoder, TurnCostEncoder

Direct Known Subclasses:

Car4WDFlagEncoder, MotorcycleFlagEncoder

public class CarFlagEncoder
extends AbstractFlagEncoder

Defines bit layout for cars. (speed, access, ferries, ...)

Author:

Peter Karich, Nop

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 int	badSurfaceSpeed
protected Set<String>	badSurfaceSpeedMap
protected Map<String,Integer>	defaultSpeedMap A map which associates string to speed.
protected int	destinationSpeed
protected Map<String,Integer>	trackTypeSpeedMap

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

absoluteBarriers, acceptBit, backwardBit, directionBitMask, 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
CarFlagEncoder()
CarFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)
CarFlagEncoder(PMap properties)
CarFlagEncoder(String propertiesStr)

Method Summary

Modifier and Type	Method and Description
long	acceptWay(ReaderWay way) Decide whether a way is routable for a given mode of travel.
protected double	applyBadSurfaceSpeed(ReaderWay way, double speed)
int	defineWayBits(int index, int shift) Define the place of the speedBits in the edge flags for car.
protected double	getSpeed(ReaderWay way)
int	getVersion()
String	getWayInfo(ReaderWay way)
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.
protected boolean	isBackwardOneway(ReaderWay way) make sure that isOneway is called before
protected boolean	isForwardOneway(ReaderWay way) make sure that isOneway is called before
protected boolean	isOneway(ReaderWay way)
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

trackTypeSpeedMap

protected final Map<String,Integer> trackTypeSpeedMap

badSurfaceSpeedMap

protected final Set<String> badSurfaceSpeedMap

badSurfaceSpeed

protected int badSurfaceSpeed

destinationSpeed

protected int destinationSpeed

defaultSpeedMap

protected final Map<String,Integer> defaultSpeedMap

A map which associates string to speed. Get some impression: http://www.itoworld.com/map/124#fullscreen http://wiki.openstreetmap.org/wiki/OSM_tags_for_routing/Maxspeed

Constructor Detail

CarFlagEncoder

public CarFlagEncoder()

CarFlagEncoder

public CarFlagEncoder(PMap properties)

CarFlagEncoder

public CarFlagEncoder(String propertiesStr)

CarFlagEncoder

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

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)

Define the place of the speedBits in the edge flags for car.

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

getSpeed

protected double getSpeed(ReaderWay way)

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.

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

isBackwardOneway

protected boolean isBackwardOneway(ReaderWay way)

make sure that isOneway is called before

isForwardOneway

protected boolean isForwardOneway(ReaderWay way)

make sure that isOneway is called before

isOneway

protected boolean isOneway(ReaderWay way)

getWayInfo

public String getWayInfo(ReaderWay way)

applyBadSurfaceSpeed

protected double applyBadSurfaceSpeed(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

toString

public String toString()

Overrides:

toString in class Object