com.graphhopper.routing.util.spatialrules

Interface SpatialRule

All Known Implementing Classes:

AbstractSpatialRule, AustriaSpatialRule, 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

Method Summary

Modifier and Type	Method and Description
RoadAccess	getAccess(RoadClass roadClass, TransportationMode transport, RoadAccess currentRoadAccess) Returns the RoadAccess for a certain highway type and transportation transport.
List<org.locationtech.jts.geom.Polygon>	getBorders() Returns the borders in which the SpatialRule is valid
String	getId() Returns the id for this rule, e.g.
double	getMaxSpeed(RoadClass roadClass, TransportationMode transport, double currentMaxSpeed) Return the max speed for a certain road class and transportation mode.
int	getPriority() Returns the priority of the rule.

Method Detail

getMaxSpeed

double getMaxSpeed(RoadClass roadClass,
                   TransportationMode transport,
                   double currentMaxSpeed)

Return the max speed for a certain road class and transportation mode.

Parameters:

roadClass - The highway type, e.g. RoadClass.MOTORWAY

transport - The mode of transportation

currentMaxSpeed - The current max speed value or Double.NaN if no value has been set yet

Returns:

the maximum speed value to be used

getAccess

RoadAccess getAccess(RoadClass roadClass,
                     TransportationMode transport,
                     RoadAccess currentRoadAccess)

Returns the RoadAccess for a certain highway type and transportation transport.

Parameters:

roadClass - The highway type, e.g. RoadClass.MOTORWAY

transport - The mode of transportation

currentRoadAccess - The current road access value (default: RoadAccess.YES)

Returns:

the type of access to be used

getBorders

List<org.locationtech.jts.geom.Polygon> getBorders()

Returns the borders in which the SpatialRule is valid

getPriority

int getPriority()

Returns the priority of the rule. If multiple rules overlap they're processed in natural order of their priority.

Returns:

the priority as an integer value between Integer.MIN_VALUE (minimum priority) and Integer.MAX_VALUE (maximum priority)

getId

String getId()

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