Freeflow attribute (#11309)

* Add new edge metadata properties

* Changelog

* Update changelog

* Bump UXF dependencies

GitOrigin-RevId: f37fdf73e834886d9d0b12c4134a195c0a3634f6

Author: DzmitryFomchyn

base/api/current.txt

@@ -1578,9 +1578,11 @@ package com.mapbox.navigation.base.trip.model.eh {
 
   public final class EHorizonEdgeMetadata {
     method public boolean getBridge();
+    method public Double? getConstrainedFlowSpeed();
     method public String? getCountryCodeIso2();
     method public String? getCountryCodeIso3();
     method public byte getCurvature();
+    method public Double? getFreeFlowSpeed();
     method public String getFunctionRoadClass();
     method public double getHeading();
     method public Byte? getLaneCount();
@@ -1599,9 +1601,11 @@ package com.mapbox.navigation.base.trip.model.eh {
     method public boolean isRightHandTraffic();
     method public boolean isUrban();
     property public final boolean bridge;
+    property public final Double? constrainedFlowSpeed;
     property public final String? countryCodeIso2;
     property public final String? countryCodeIso3;
     property public final byte curvature;
+    property public final Double? freeFlowSpeed;
     property public final String functionRoadClass;
     property public final double heading;
     property public final boolean isOneWay;

base/src/main/java/com/mapbox/navigation/base/trip/model/eh/EHorizonEdgeMetadata.kt

@@ -18,6 +18,8 @@ import com.mapbox.navigation.base.road.model.RoadComponent
  * @param functionRoadClass the edge's [RoadClass]
  * @param speedLimit max speed of the edge (speed limit) in m/s
  * @param speed average speed along the edge in m/s
+ * @param freeFlowSpeed Optional edge's free flow speed (m/s) when there is no traffic
+ * @param constrainedFlowSpeed Optional edge's constrained flow speed (m/s) when there is traffic
  * @param ramp is the edge a ramp?
  * @param motorway is the edge a motorway?
  * @param bridge is the edge a bridge?
@@ -42,6 +44,8 @@ class EHorizonEdgeMetadata internal constructor(
     val functionRoadClass: String,
     val speedLimit: Double?,
     val speed: Double,
+    val freeFlowSpeed: Double?,
+    val constrainedFlowSpeed: Double?,
     val ramp: Boolean,
     val motorway: Boolean,
     val bridge: Boolean,
@@ -74,6 +78,8 @@ class EHorizonEdgeMetadata internal constructor(
         if (functionRoadClass != other.functionRoadClass) return false
         if (speedLimit != other.speedLimit) return false
         if (speed != other.speed) return false
+        if (freeFlowSpeed != other.freeFlowSpeed) return false
+        if (constrainedFlowSpeed != other.constrainedFlowSpeed) return false
         if (ramp != other.ramp) return false
         if (motorway != other.motorway) return false
         if (bridge != other.bridge) return false
@@ -103,6 +109,8 @@ class EHorizonEdgeMetadata internal constructor(
         result = 31 * result + functionRoadClass.hashCode()
         result = 31 * result + speedLimit.hashCode()
         result = 31 * result + speed.hashCode()
+        result = 31 * result + freeFlowSpeed.hashCode()
+        result = 31 * result + constrainedFlowSpeed.hashCode()
         result = 31 * result + ramp.hashCode()
         result = 31 * result + motorway.hashCode()
         result = 31 * result + bridge.hashCode()
@@ -132,6 +140,8 @@ class EHorizonEdgeMetadata internal constructor(
             "functionRoadClass='$functionRoadClass', " +
             "speedLimit=$speedLimit, " +
             "speed=$speed, " +
+            "freeFlowSpeed=$freeFlowSpeed, " +
+            "constrainedFlowSpeed=$constrainedFlowSpeed, " +
             "ramp=$ramp, " +
             "motorway=$motorway, " +
             "bridge=$bridge, " +

base/src/main/java/com/mapbox/navigation/base/trip/model/eh/EHorizonMapper.kt

@@ -325,27 +325,29 @@ internal fun RoadObjectEdgeLocation.mapToRoadObjectEdgeLocation(): SDKRoadObject
  */
 internal fun EdgeMetadata.mapToEHorizonEdgeMetadata(): EHorizonEdgeMetadata {
     return EHorizonEdgeMetadata(
-        heading,
-        length,
-        frc.mapToRoadClass(),
-        speedLimit,
-        speed,
-        ramp,
-        motorway,
-        bridge,
-        tunnel,
-        toll,
-        mapNames(names),
-        laneCount,
-        meanElevation,
-        curvature,
-        countryCodeIso3,
-        countryCodeIso2,
-        stateCode,
-        isRightHandTraffic,
-        isOneway,
-        surface.mapToRoadSurface(),
-        isUrban,
+        heading = heading,
+        length = length,
+        functionRoadClass = frc.mapToRoadClass(),
+        speedLimit = speedLimit,
+        speed = speed,
+        freeFlowSpeed = freeFlowSpeed,
+        constrainedFlowSpeed = constrainedFlowSpeed,
+        ramp = ramp,
+        motorway = motorway,
+        bridge = bridge,
+        tunnel = tunnel,
+        toll = toll,
+        names = mapNames(names),
+        laneCount = laneCount,
+        meanElevation = meanElevation,
+        curvature = curvature,
+        countryCodeIso3 = countryCodeIso3,
+        countryCodeIso2 = countryCodeIso2,
+        stateCode = stateCode,
+        isRightHandTraffic = isRightHandTraffic,
+        isOneWay = isOneway,
+        roadSurface = surface.mapToRoadSurface(),
+        isUrban = isUrban,
     )
 }
 

changelog/unreleased/features/11309.md

@@ -0,0 +1 @@
+- Added `freeFlowSpeed` and `constrainedFlowSpeed` properties to `EHorizonEdgeMetadata` to provide free flow and constrained flow speed information for edges

gradle/dependencies.gradle

@@ -11,7 +11,7 @@ ext {
   // mapboxSdkHdFullSparseCheckout in generate_api_docs_android.sh depends on mapboxSdkVersionSuffix
   // Release Train depends on these two lines below
   // https://github.com/mapbox/release-train/blob/bd530da200d62fb45166ef91d7d892d90a453fa6/backend/model/step/navcoreandroid/PrepareChangelogNavCore.py#L122-L124
-  def mapboxSdkVersionSuffix = '17.0-beta.1-SNAPSHOT-11-10--11-43.git-9f387dc'
+  def mapboxSdkVersionSuffix = '17.0-beta.2'
   def mapboxNavigatorVersion = "324.${mapboxSdkVersionSuffix}"
 
   def ndkVersionSuffix = ""