add max_hiking_difficulty configuration to valhalla router (#129)

* add max_hiking_difficulty configuration to valhalla router * provide hikingdifficulty documentation and fixup method name
mapzen · Jun 26, 2020 · 2d4e582 · 2d4e582
1 parent 05501f5
commit 2d4e582
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/library/src/main/java/com/mapzen/valhalla/JSON.java b/library/src/main/java/com/mapzen/valhalla/JSON.java
@@ -15,6 +15,14 @@ public class JSON {
     @SerializedName("directions_options")
     public DirectionOptions directionsOptions = new DirectionOptions();
 
+    @SerializedName("costing_options")
+    public CostingOptions costingOptions = new CostingOptions();
+
+    public static class CostingOptions {
+        @SerializedName("max_hiking_difficulty")
+        public String maxHikingDifficulty;
+    }
+
     public static class Location {
         public double lat;
         public double lon;

diff --git a/library/src/main/java/com/mapzen/valhalla/Router.kt b/library/src/main/java/com/mapzen/valhalla/Router.kt
@@ -56,6 +56,16 @@ interface Router {
             city: String? = null,
             state: String? = null): Router
     fun setDistanceUnits(units: DistanceUnits): Router
+    /*
+     * Sets the difficulty for hiking route types
+     *
+     * This value indicates the maximum difficulty of hiking trails that is allowed. Values between
+     * 0 and 6 are allowed. The values correspond to sac_scale values within OpenStreetMap. The
+     * default value is 1 which means that well cleared trails that are mostly flat or slightly
+     * sloped are allowed. Higher difficulty trails can be allowed by specifying a higher value for
+     * maxHikingDifficulty.
+     */
+    fun setMaxHikingDifficulty(difficulty: Int): Router
     fun clearLocations(): Router
     fun setCallback(callback: RouteCallback): Router
     fun fetch(): Call<String>?

diff --git a/library/src/main/java/com/mapzen/valhalla/ValhallaRouter.kt b/library/src/main/java/com/mapzen/valhalla/ValhallaRouter.kt
@@ -12,6 +12,7 @@ open class ValhallaRouter : Router {
     private var language: String? = null
     private var type = Router.Type.DRIVING
     private val locations = ArrayList<JSON.Location>()
+    private var maxDifficulty = 1
     private var callback: RouteCallback? = null
     private var units: Router.DistanceUnits = Router.DistanceUnits.KILOMETERS
 
@@ -73,6 +74,11 @@ open class ValhallaRouter : Router {
         return this
     }
 
+    override fun setMaxHikingDifficulty(difficulty: Int): Router {
+        this.maxDifficulty = difficulty
+        return this
+    }
+
     override fun clearLocations(): Router {
         this.locations.clear()
         return this
@@ -117,6 +123,7 @@ open class ValhallaRouter : Router {
         json.costing = this.type.toString()
         json.directionsOptions.language = language
         json.directionsOptions.units = this.units.toString()
+        json.costingOptions.maxHikingDifficulty = this.maxDifficulty.toString()
         return json
     }