com.graphhopper.routing.util.spatialrules

Class SpatialRuleSet

java.lang.Object

com.graphhopper.routing.util.spatialrules.SpatialRuleSet

public class SpatialRuleSet
extends Object

Contains all rules which are applicable for a certain position.

Author:

Thomas Butz

Field Summary

Fields

Modifier and Type	Field and Description
static SpatialRuleSet	EMPTY

Constructor Summary

Constructors

Constructor and Description
SpatialRuleSet(List<SpatialRule> rules, int spatialId)

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 mode.
double	getMaxSpeed(RoadClass roadClass, TransportationMode transport, double currentMaxSpeed) Return the max speed for a certain road class.
List<SpatialRule>	getRules()
int	getSpatialId()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final SpatialRuleSet EMPTY

Constructor Detail

SpatialRuleSet

public SpatialRuleSet(List<SpatialRule> rules,
                      int spatialId)

Parameters:

rules - a List of rules, ordered according to how they are to be applied

spatialId - the index of the rule with the highest priority

Method Detail

getMaxSpeed

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

Return the max speed for a certain road class.

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

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

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

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

getRules

public List<SpatialRule> getRules()

Returns:

the rules in this set

getSpatialId

public int getSpatialId()

Returns:

the id of the rule with the highest priority or 0 if the set doesn't contain any rules

toString

public String toString()

Overrides:

toString in class Object