com.graphhopper.routing.util

Interface FlagEncoder

All Superinterfaces:

TurnCostEncoder

All Known Implementing Classes:

AbstractFlagEncoder, Bike2WeightFlagEncoder, BikeCommonFlagEncoder, BikeFlagEncoder, Car4WDFlagEncoder, CarFlagEncoder, DataFlagEncoder, FootFlagEncoder, HikeFlagEncoder, MotorcycleFlagEncoder, MountainBikeFlagEncoder, RacingBikeFlagEncoder

public interface FlagEncoder
extends TurnCostEncoder

This class provides methods to define how a value (like speed or direction) converts to a flag (currently an integer value), which is stored in an edge .

Author:

Peter Karich

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	K_ROUNDABOUT Reports whether this edge is part of a roundabout.

Method Summary

Modifier and Type	Method and Description
InstructionAnnotation	getAnnotation(long flags, Translation tr)
double	getDouble(long flags, int key) Returns arbitrary double value identified by the specified key.
long	getLong(long flags, int key) Returns arbitrary long value identified by the specified key.
double	getMaxSpeed()
double	getReverseSpeed(long flags)
double	getSpeed(long flags)
int	getVersion()
boolean	isBackward(long flags) Reports whether the edge is available in backward direction (i.e.
boolean	isBool(long flags, int key) Returns arbitrary boolean value identified by the specified key.
boolean	isForward(long flags) Reports whether the edge is available in forward direction (i.e.
boolean	isRegistered()
long	setAccess(long flags, boolean forward, boolean backward) Sets the access of the edge.
long	setBool(long flags, int key, boolean value)
long	setDouble(long flags, int key, double value)
long	setLong(long flags, int key, long value)
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.
long	setSpeed(long flags, double speed) Sets the speed in km/h.
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.

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

getTurnCost, getTurnFlags, isTurnRestricted

Field Detail

K_ROUNDABOUT

static final int K_ROUNDABOUT

Reports whether this edge is part of a roundabout.

See Also:

Constant Field Values

Method Detail

getVersion

int getVersion()

Returns:

the version of this FlagEncoder to enforce none-compatibility when new attributes are introduced

getMaxSpeed

double getMaxSpeed()

Returns:

the maximum speed in km/h

getSpeed

double getSpeed(long flags)

Returns:

the speed in km/h for this direction, for backward direction use getReverseSpeed

setSpeed

long setSpeed(long flags,
              double speed)

Sets the speed in km/h.

Returns:

modified setProperties

getReverseSpeed

double getReverseSpeed(long flags)

Returns:

the speed of the reverse direction in km/h

setReverseSpeed

long setReverseSpeed(long flags,
                     double speed)

Sets the reverse speed in the flags.

setAccess

long setAccess(long flags,
               boolean forward,
               boolean backward)

Sets the access of the edge.

Returns:

modified flags

setProperties

long setProperties(double speed,
                   boolean forward,
                   boolean backward)

Sets speed and access properties.

Returns:

created flags

isForward

boolean isForward(long flags)

Reports whether the edge is available in forward direction (i.e. from base node to adj node) for a certain vehicle.

isBackward

boolean isBackward(long flags)

Reports whether the edge is available in backward direction (i.e. from adj node to base node) for a certain vehicle.

isBool

boolean isBool(long flags,
               int key)

Returns arbitrary boolean value identified by the specified key.

setBool

long setBool(long flags,
             int key,
             boolean value)

getLong

long getLong(long flags,
             int key)

Returns arbitrary long value identified by the specified key. E.g. can be used to return the way or surface type of an edge

setLong

long setLong(long flags,
             int key,
             long value)

getDouble

double getDouble(long flags,
                 int key)

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.

setDouble

long setDouble(long flags,
               int key,
               double value)

supports

boolean supports(Class<?> feature)

Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.

getAnnotation

InstructionAnnotation getAnnotation(long flags,
                                    Translation tr)

Returns:

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

isRegistered

boolean isRegistered()

Returns:

true if already registered in an EncodingManager