com.graphhopper.routing.util

Interface FlagEncoder

All Superinterfaces:

EncodedValueLookup, TurnCostEncoder

All Known Implementing Classes:

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

public interface FlagEncoder
extends TurnCostEncoder, EncodedValueLookup

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

Method Summary

Modifier and Type	Method and Description
BooleanEncodedValue	getAccessEnc() This method returns the EncodedValue used for the direction-dependent access properties of this encoder.
InstructionAnnotation	getAnnotation(IntsRef intsRef, Translation tr)
DecimalEncodedValue	getAverageSpeedEnc() This method returns the EncodedValue used for the average speed of this encoder.
double	getMaxSpeed()
int	getVersion()
boolean	isRegistered()
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

Methods inherited from interface com.graphhopper.routing.profiles.EncodedValueLookup

getBooleanEncodedValue, getDecimalEncodedValue, getEncodedValue, getEnumEncodedValue, getIntEncodedValue, hasEncodedValue

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

getAccessEnc

BooleanEncodedValue getAccessEnc()

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

getAverageSpeedEnc

DecimalEncodedValue getAverageSpeedEnc()

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

supports

boolean supports(Class<?> feature)

Returns true if the feature class is supported like TurnWeighting or PriorityWeighting. Use support(String) instead.

getAnnotation

InstructionAnnotation getAnnotation(IntsRef intsRef,
                                    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