com.graphhopper.routing.util

Interface FlagEncoder

All Superinterfaces:

EncodedValueLookup

All Known Implementing Classes:

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

public interface FlagEncoder
extends 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

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.
DecimalEncodedValue	getAverageSpeedEnc() This method returns the EncodedValue used for the average speed of this encoder.
double	getMaxSpeed()
TransportationMode	getTransportationMode()
int	getVersion()
boolean	isRegistered()
boolean	supports(Class<?> feature) Returns true if the feature class is supported like TurnWeighting or PriorityWeighting.
boolean	supportsTurnCosts()

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

getAllShared, 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

getTransportationMode

TransportationMode getTransportationMode()

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.

supportsTurnCosts

boolean supportsTurnCosts()

supports

boolean supports(Class<?> feature)

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

isRegistered

boolean isRegistered()

Returns:

true if already registered in an EncodingManager