com.graphhopper.routing.util.spatialrules

Class AbstractSpatialRule

java.lang.Object

com.graphhopper.routing.util.spatialrules.AbstractSpatialRule

All Implemented Interfaces:

SpatialRule

Direct Known Subclasses:

AustriaSpatialRule, GermanySpatialRule

public abstract class AbstractSpatialRule
extends Object
implements SpatialRule

Author:

Robin Boldt

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractSpatialRule(List<org.locationtech.jts.geom.Polygon> borders)
AbstractSpatialRule(org.locationtech.jts.geom.Polygon border)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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
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.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.graphhopper.routing.util.spatialrules.SpatialRule

getId

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Constructor Detail

AbstractSpatialRule

public AbstractSpatialRule(List<org.locationtech.jts.geom.Polygon> borders)

AbstractSpatialRule

public AbstractSpatialRule(org.locationtech.jts.geom.Polygon border)

Method Detail

getMaxSpeed

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

Description copied from interface: SpatialRule

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

Specified by:

getMaxSpeed in interface SpatialRule

Parameters:

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

transport - The mode of transportation

currentMaxSpeed - The current max speed value or -1 if no value has been set yet

Returns:

the maximum speed value to be used

getAccess

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

Description copied from interface: SpatialRule

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

Specified by:

getAccess in interface SpatialRule

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

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

Description copied from interface: SpatialRule

Returns the borders in which the SpatialRule is valid

Specified by:

getBorders in interface SpatialRule

getPriority

public int getPriority()

Description copied from interface: SpatialRule

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

Specified by:

getPriority in interface SpatialRule

Returns:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object