com.graphhopper.routing.util.spatialrules

Interface SpatialRule

All Known Implementing Classes:

AbstractSpatialRule, AustriaSpatialRule, DefaultSpatialRule, GermanySpatialRule

public interface SpatialRule

Defines rules that are valid for a certain region, e.g. a country. A rule defines access, max-speed, etc. dependent on this region.

Every SpatialRule has a set of borders. The rules are valid inside of these borders.

Author:

Robin Boldt

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpatialRule.Access

Field Summary

Fields

Modifier and Type	Field and Description
static SpatialRule	EMPTY

Method Summary

Modifier and Type	Method and Description
SpatialRule.Access	getAccess(String highwayTag, TransportationMode transportationMode, SpatialRule.Access _default) Returns the SpatialRule.Access for a certain highway type and transportation mode.
List<Polygon>	getBorders() Returns the borders in which the SpatialRule is valid
String	getId() Returns the id for this rule, e.g.
double	getMaxSpeed(String highway, double _default) Return the max speed for a certain highway type.

Field Detail

EMPTY

static final SpatialRule EMPTY

Method Detail

getMaxSpeed

double getMaxSpeed(String highway,
                   double _default)

Return the max speed for a certain highway type. If there is no max speed defined, _default will be returned.

Parameters:

highway - The highway type, e.g. primary, secondary

_default - The default max speed

Returns:

max speed

getAccess

SpatialRule.Access getAccess(String highwayTag,
                             TransportationMode transportationMode,
                             SpatialRule.Access _default)

Returns the SpatialRule.Access for a certain highway type and transportation mode. If nothing is defined, _default will be returned.

Parameters:

highwayTag - The highway type, e.g. primary, secondary

transportationMode - The mode of transportation

_default - The default AccessValue

getBorders

List<Polygon> getBorders()

Returns the borders in which the SpatialRule is valid

getId

String getId()

Returns the id for this rule, e.g. the ISO name of the country. The id has to be unique.