Merge pull request graphhopper#279 from graphhopper/motorbike

motorcycle profile

Author: Peter

config-example.properties

@@ -12,7 +12,7 @@ prepare.chWeighting=fastest
 # increase from 1 to 5, to reduce way geometry e.g. for android
 osmreader.wayPointMaxDistance=1
 
-# Possible options: car,foot,bike,bike2,mtb,racingbike (comma separated)
+# Possible options: car,foot,bike,bike2,mtb,racingbike,motorcycle (comma separated)
 # When using two or three option together remeber to set "prepare.chWeighting=no" above.
 # bike2 takes elevation data into account (like up-hill is slower than down-hill)
 # and requires enabling graph.elevation.provider below, e.g. see #169

core/files/changelog.txt

@@ -12,14 +12,12 @@
     renaming of GraphHopper.setCHShortcuts to setCHWeighting, as well as the property prepare.chShortcuts to prepare.chWeighting
     jsonp is disabled by default. You need to enable it in the config.properties, see the config-example.properties
     EncodingManager cannot be null in GraphHopperStorage since 0.4. If you need to parse EncodingManager configuration from existing graph use EncodingManager.create
-    no reflection done in EncodingManager which improves portability and makes configuration of encoders
+    no reflection done in EncodingManager which improves portability and makes configuration of encoders possible before adding to manager
     removed dijkstraNativebi as no performance advantage but maintenance disadvantage and similar to oneToManyDijkstra
-    osmreader.bytesForFlags changed to graph.bytesForFlags
-    to provide context for turn costs we needed to add prevEdgeId into Weighting.calcWeight
+    to provide context for turn costs we needed to add prevEdgeId into Weighting.calcWeight, see new documentation
     with the introduction of lock protection mechanism (see #112) GraphHopper needs always write access, see also #217
-    new GraphHopper.clean method to remove the directory via Java API
+    new GraphHopper.clean method to remove the graph directory via Java API
     FlagEncoder: replaced isFoward and isBackward with more generic isBool(flags, FlagEncoder.FORWARD|BACKWARD)
-        restrictions type was: String[], is: List<String>
 
 0.3.0
     introduced prefer bits, now bike uses more bits and 3 bike encoder do not fit into 32 bit anymore, will be fixed later

core/src/main/java/com/graphhopper/GraphHopper.java

@@ -777,7 +777,7 @@ public Weighting createWeighting( WeightingMap wMap, FlagEncoder encoder )
             result = new ShortestWeighting();
         } else if ("fastest".equalsIgnoreCase(weighting) || weighting.isEmpty())
         {
-            if (encoder instanceof BikeCommonFlagEncoder)
+            if (encoder instanceof BikeCommonFlagEncoder || encoder instanceof MotorcycleFlagEncoder)
                 result = new PriorityWeighting(encoder);
             else
                 result = new FastestWeighting(encoder);

core/src/main/java/com/graphhopper/routing/util/AbstractFlagEncoder.java

@@ -67,20 +67,19 @@ public abstract class AbstractFlagEncoder implements FlagEncoder, TurnCostEncode
     protected EdgeExplorer edgeInExplorer;
 
     /* restriction definitions where order is important */
-    protected List<String> restrictions = new ArrayList<String>(5);
-    protected HashSet<String> intendedValues = new HashSet<String>(5);
-    protected HashSet<String> restrictedValues = new HashSet<String>(5);
-    protected HashSet<String> ferries = new HashSet<String>(5);
-    protected HashSet<String> oneways = new HashSet<String>(5);
-    protected HashSet<String> acceptedRailways = new HashSet<String>(5);
+    protected final List<String> restrictions = new ArrayList<String>(5);
+    protected final HashSet<String> intendedValues = new HashSet<String>(5);
+    protected final HashSet<String> restrictedValues = new HashSet<String>(5);
+    protected final HashSet<String> ferries = new HashSet<String>(5);
+    protected final HashSet<String> oneways = new HashSet<String>(5);
+    protected final HashSet<String> acceptedRailways = new HashSet<String>(5);
     // http://wiki.openstreetmap.org/wiki/Mapfeatures#Barrier
-    protected HashSet<String> absoluteBarriers = new HashSet<String>(5);
-    protected HashSet<String> potentialBarriers = new HashSet<String>(5);
-    // should potential barriers block when no access limits are given?
-    protected boolean blockByDefault = true;
-    protected boolean blockFords = true;
-    protected int speedBits;
-    protected double speedFactor;
+    protected final HashSet<String> absoluteBarriers = new HashSet<String>(5);
+    protected final HashSet<String> potentialBarriers = new HashSet<String>(5);
+    private boolean blockByDefault = true;
+    private boolean blockFords = true;
+    protected final int speedBits;
+    protected final double speedFactor;
 
     /**
      * @param speedBits specify the number of bits used for speed
@@ -105,14 +104,32 @@ protected AbstractFlagEncoder( int speedBits, double speedFactor, int maxTurnCos
         acceptedRailways.add("tram");
         acceptedRailways.add("abandoned");
         acceptedRailways.add("disused");
-        
+
         // http://wiki.openstreetmap.org/wiki/Demolished_Railway
         acceptedRailways.add("dismantled");
         acceptedRailways.add("razed");
         acceptedRailways.add("historic");
         acceptedRailways.add("obliterated");
     }
 
+    /**
+     * Should potential barriers block when no access limits are given?
+     */
+    public void setBlockByDefault( boolean blockByDefault )
+    {
+        this.blockByDefault = blockByDefault;
+    }
+
+    public void setBlockFords( boolean blockFords )
+    {
+        this.blockFords = blockFords;
+    }
+
+    public boolean isBlockFords()
+    {
+        return blockFords;
+    }
+
     /**
      * Defines the bits for the node flags, which are currently used for barriers only.
      * <p>
@@ -743,6 +760,21 @@ protected static String getStr( String str, String key )
         return "";
     }
 
+    /**
+     * @param force should be false if speed should be changed only if it is bigger than maxspeed.
+     */
+    protected double applyMaxSpeed( OSMWay way, double speed, boolean force )
+    {
+        double maxSpeed = getMaxSpeed(way);
+        // apply only if smaller maxSpeed
+        if (maxSpeed >= 0)
+        {
+            if (force || maxSpeed < speed)
+                return maxSpeed * 0.9;
+        }
+        return speed;
+    }
+
     protected String getPropertiesString()
     {
         return "speedFactor=" + speedFactor + "|speedBits=" + speedBits + "|turnCosts=" + (maxTurnCosts > 0);

core/src/main/java/com/graphhopper/routing/util/Bike2WeightFlagEncoder.java

@@ -52,7 +52,7 @@ public Bike2WeightFlagEncoder( int speedBits, double speedFactor, int maxTurnCos
     public int defineWayBits( int index, int shift )
     {
         shift = super.defineWayBits(index, shift);
-        reverseSpeed = new EncodedDoubleValue("Speed", shift, speedBits, speedFactor, getHighwaySpeed("cycleway"), 30);
+        reverseSpeed = new EncodedDoubleValue("Reverse Speed", shift, speedBits, speedFactor, getHighwaySpeed("cycleway"), 30);
         shift += reverseSpeed.getBits();
         return shift;
     }

core/src/main/java/com/graphhopper/routing/util/BikeCommonFlagEncoder.java

@@ -19,22 +19,26 @@
 
 import com.graphhopper.reader.OSMWay;
 import com.graphhopper.reader.OSMRelation;
-import static com.graphhopper.routing.util.BikeCommonFlagEncoder.PriorityCode.*;
+import static com.graphhopper.routing.util.PriorityCode.*;
 import com.graphhopper.util.Helper;
 import com.graphhopper.util.InstructionAnnotation;
 import com.graphhopper.util.Translation;
 
 import java.util.*;
 
 /**
- * Defines bit layout of bicycles (not motorbikes) for speed, access and relations (network).
+ * Defines bit layout of bicycles (not motorcycles) for speed, access and relations (network).
  * <p/>
  * @author Peter Karich
  * @author Nop
  * @author ratrun
  */
 public class BikeCommonFlagEncoder extends AbstractFlagEncoder
 {
+    /**
+     * Reports wether this edge is unpaved.
+     */
+    public static final int K_UNPAVED = 100;
     protected static final int PUSHING_SECTION_SPEED = 4;
     private long unpavedBit = 0;
     // Pushing section heighways are parts where you need to get off your bike and push it (German: Schiebestrecke)
@@ -51,13 +55,13 @@ public class BikeCommonFlagEncoder extends AbstractFlagEncoder
     private final Map<String, Integer> bikeNetworkToCode = new HashMap<String, Integer>();
     EncodedValue relationCodeEncoder;
     private EncodedValue wayTypeEncoder;
-    private EncodedValue preferWayEncoder;    
+    private EncodedValue preferWayEncoder;
 
     protected BikeCommonFlagEncoder( int speedBits, double speedFactor, int maxTurnCosts )
     {
         super(speedBits, speedFactor, maxTurnCosts);
         // strict set, usually vehicle and agricultural/forestry are ignored by cyclists
-        restrictions = new ArrayList<String>(Arrays.asList("bicycle", "access"));
+        restrictions.addAll(Arrays.asList("bicycle", "access"));
         restrictedValues.add("private");
         restrictedValues.add("no");
         restrictedValues.add("restricted");
@@ -71,7 +75,7 @@ protected BikeCommonFlagEncoder( int speedBits, double speedFactor, int maxTurnC
         oppositeLanes.add("opposite_lane");
         oppositeLanes.add("opposite_track");
 
-        blockByDefault = false;
+        setBlockByDefault(false);
         potentialBarriers.add("gate");
         // potentialBarriers.add("lift_gate");
         potentialBarriers.add("swing_gate");
@@ -238,7 +242,7 @@ public long acceptWay( OSMWay way )
             return 0;
 
         // do not use fords with normal bikes, flagged fords are in included above
-        if (blockFords && (way.hasTag("highway", "ford") || way.hasTag("ford")))
+        if (isBlockFords() && (way.hasTag("highway", "ford") || way.hasTag("ford")))
             return 0;
 
         // check access restrictions
@@ -251,7 +255,7 @@ public long acceptWay( OSMWay way )
 
         String sacScale = way.getTag("sac_scale");
         if (sacScale != null)
-        {            
+        {
             if (!allowedSacScale(sacScale))
                 return 0;
         }
@@ -298,10 +302,10 @@ public long handleWayTags( OSMWay way, long allowed, long relationFlags )
             if (relationFlags != 0)
                 priorityFromRelation = (int) relationCodeEncoder.getValue(relationFlags);
 
-            encoded = setLong(encoded, K_PRIORITY_LONG, handlePriority(way, priorityFromRelation));
+            encoded = setLong(encoded, PriorityWeighting.KEY, handlePriority(way, priorityFromRelation));
 
             // bike maxspeed handling is different from car as we don't increase speed
-            speed = reduceToMaxSpeed(way, speed);
+            speed = applyMaxSpeed(way, speed, false);
             encoded = handleSpeed(way, speed, encoded);
             encoded = handleBikeRelated(way, encoded, relationFlags > UNCHANGED.getValue());
 
@@ -316,18 +320,6 @@ public long handleWayTags( OSMWay way, long allowed, long relationFlags )
         return encoded;
     }
 
-    protected double reduceToMaxSpeed( OSMWay way, double speed )
-    {
-        double maxSpeed = getMaxSpeed(way);
-        // apply only if smaller maxSpeed
-        if (maxSpeed >= 0)
-        {
-            if (maxSpeed < speed)
-                return maxSpeed * 0.9;
-        }
-        return speed;
-    }
-
     int getSpeed( OSMWay way )
     {
         int speed = PUSHING_SECTION_SPEED;
@@ -458,7 +450,8 @@ void collect( OSMWay way, TreeMap<Double, Integer> weightToPrioMap )
         if ("cycleway".equals(highway))
             weightToPrioMap.put(100d, VERY_NICE.getValue());
 
-        if (preferHighwayTags.contains(highway))
+        double maxSpeed = getMaxSpeed(way);
+        if (preferHighwayTags.contains(highway) || maxSpeed > 0 && maxSpeed <= 30)
         {
             weightToPrioMap.put(40d, PREFER.getValue());
             if (way.hasTag("tunnel", intendedValues))
@@ -468,7 +461,6 @@ void collect( OSMWay way, TreeMap<Double, Integer> weightToPrioMap )
         if (pushingSections.contains(highway) || "parking_aisle".equals(service))
             weightToPrioMap.put(50d, AVOID_IF_POSSIBLE.getValue());
 
-        double maxSpeed = getMaxSpeed(way);
         if (avoidHighwayTags.contains(highway) || maxSpeed > 80)
         {
             weightToPrioMap.put(50d, REACH_DEST.getValue());
@@ -516,12 +508,6 @@ else if (roadValues.contains(highway))
         return wayTypeEncoder.setValue(encoded, wayType.getValue());
     }
 
-    /**
-     * Reports wether this edge is unpaved.
-     */
-    public static final int K_UNPAVED = 100;
-    public static final int K_PRIORITY = 101, K_PRIORITY_LONG = 102;
-
     @Override
     public long setBool( long flags, int key, boolean value )
     {
@@ -551,7 +537,7 @@ public double getDouble( long flags, int key )
     {
         switch (key)
         {
-            case K_PRIORITY:
+            case PriorityWeighting.KEY:
                 double prio = preferWayEncoder.getValue(flags);
                 if (prio == 0)
                     return (double) UNCHANGED.getValue() / BEST.getValue();
@@ -567,7 +553,7 @@ public long getLong( long flags, int key )
     {
         switch (key)
         {
-            case K_PRIORITY_LONG:
+            case PriorityWeighting.KEY:
                 return preferWayEncoder.getValue(flags);
             default:
                 return super.getLong(flags, key);
@@ -579,7 +565,7 @@ public long setLong( long flags, int key, long value )
     {
         switch (key)
         {
-            case K_PRIORITY_LONG:
+            case PriorityWeighting.KEY:
                 return preferWayEncoder.setValue(flags, value);
             default:
                 return super.setLong(flags, key, value);
@@ -612,44 +598,6 @@ protected long handleSpeed( OSMWay way, double speed, long encoded )
         return encoded;
     }
 
-    enum PriorityCode
-    {
-        /* Inspired by http://wiki.openstreetmap.org/wiki/Class:bicycle
-         "-3" = Avoid at all cost. 
-         "-2" = Only use to reach your destination, not well suited. 
-         "-1" = Better take another way 
-         "0" = as well as other ways around. 
-         Try to to avoid using 0 but decide on -1 or +1. 
-         class:bicycle shall only be used as an additional key. 
-         "1" = Prefer 
-         "2" = Very Nice way to cycle 
-         "3" = This way is so nice, it pays out to make a detour also if this means taking 
-         many unsuitable ways to get here. Outstanding for its intendedValues usage class.
-         */
-        //We can't store negative numbers into our map, therefore we add 
-        //unspecifiedRelationWeight=4 to the schema from above
-        WORST(0),
-        AVOID_AT_ALL_COSTS(1),
-        REACH_DEST(2),
-        AVOID_IF_POSSIBLE(3),
-        UNCHANGED(4),
-        PREFER(5),
-        VERY_NICE(6),
-        BEST(7);
-
-        private final int value;
-
-        private PriorityCode( int value )
-        {
-            this.value = value;
-        }
-
-        public int getValue()
-        {
-            return value;
-        }
-    };
-
     private enum WayType
     {
         ROAD(0),