com.graphhopper.routing.util

Class MotorcycleFlagEncoder

java.lang.Object

com.graphhopper.routing.util.AbstractFlagEncoder

com.graphhopper.routing.util.CarFlagEncoder

com.graphhopper.routing.util.MotorcycleFlagEncoder

All Implemented Interfaces:

FlagEncoder, TurnCostEncoder

public class MotorcycleFlagEncoder
extends CarFlagEncoder

Defines bit layout for motorbikes

Author:

Peter Karich, boldtrn

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
static int	CURVATURE_KEY

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

badSurfaceSpeed, badSurfaceSpeedMap, defaultSpeedMap, destinationSpeed, trackTypeSpeedMap

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
MotorcycleFlagEncoder()
MotorcycleFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts)
MotorcycleFlagEncoder(PMap properties)
MotorcycleFlagEncoder(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.
void	applyWayTags(ReaderWay way, EdgeIteratorState edge) Second parsing step.
protected int	convertToInt(double bendiness)
protected double	correctErrors(double bendiness) A really small bendiness or a bendiness greater than 1 indicates an error in the calculation.
int	defineWayBits(int index, int shift) Define the place of the speedBits in the edge flags for car.
protected double	discriminateSlowStreets(double bendiness, double speed) Streets that slow are not fun and probably in a town.
long	flagsDefault(boolean forward, boolean backward) Sets default flags with specified access.
double	getDouble(long flags, int key) Returns arbitrary double value identified by the specified key.
double	getReverseSpeed(long flags)
int	getVersion()
long	handleWayTags(ReaderWay way, long allowed, long priorityFromRelation) Analyze properties of a way and create the routing flags.
protected double	increaseBendinessImpact(double bendiness) A good bendiness should become a greater impact.
long	reverseFlags(long flags) Swapping directions means swapping bits which are dependent on the direction of an edge like the access bits.
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.
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.CarFlagEncoder

applyBadSurfaceSpeed, getSpeed, getWayInfo, handleRelationTags, isBackwardOneway, isForwardOneway, isOneway

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CURVATURE_KEY

public static final int CURVATURE_KEY

See Also:

Constant Field Values

Constructor Detail

MotorcycleFlagEncoder

public MotorcycleFlagEncoder()

MotorcycleFlagEncoder

public MotorcycleFlagEncoder(PMap properties)

MotorcycleFlagEncoder

public MotorcycleFlagEncoder(String propertiesStr)

MotorcycleFlagEncoder

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

Method Detail

getVersion

public int getVersion()

Specified by:

getVersion in interface FlagEncoder

Overrides:

getVersion in class CarFlagEncoder

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 CarFlagEncoder

shift - bit offset for the first bit used by this encoder

Returns:

incremented shift value pointing behind the last used bit

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.

Overrides:

acceptWay in class CarFlagEncoder

Returns:

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

handleWayTags

public long handleWayTags(ReaderWay way,
                          long allowed,
                          long priorityFromRelation)

Description copied from class: AbstractFlagEncoder

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

Overrides:

handleWayTags in class CarFlagEncoder

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

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

setLowSpeed

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

Overrides:

setLowSpeed in class AbstractFlagEncoder

flagsDefault

public long flagsDefault(boolean forward,
                         boolean backward)

Description copied from class: AbstractFlagEncoder

Sets default flags with specified access.

Overrides:

flagsDefault in class AbstractFlagEncoder

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

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

getDouble

public double getDouble(long flags,
                        int key)

Description copied from interface: FlagEncoder

Returns arbitrary double value identified by the specified key. E.g. can be used to return the maximum width or height allowed for an edge.

Specified by:

getDouble in interface FlagEncoder

Overrides:

getDouble in class AbstractFlagEncoder

applyWayTags

public void applyWayTags(ReaderWay way,
                         EdgeIteratorState edge)

Description copied from class: AbstractFlagEncoder

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.

Overrides:

applyWayTags in class AbstractFlagEncoder

discriminateSlowStreets

protected double discriminateSlowStreets(double bendiness,
                                         double speed)

Streets that slow are not fun and probably in a town.

correctErrors

protected double correctErrors(double bendiness)

A really small bendiness or a bendiness greater than 1 indicates an error in the calculation. Just ignore them. We use bendiness greater 1.2 since the beelineDistance is only approximated, therefore it can happen on straight roads, that the beeline is longer than the road.

increaseBendinessImpact

protected double increaseBendinessImpact(double bendiness)

A good bendiness should become a greater impact. A bendiness close to 1 should not be changed.

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

convertToInt

protected int convertToInt(double bendiness)

toString

public String toString()

Overrides:

toString in class CarFlagEncoder