Base/com.mapbox.navigation.base.trip.model.roadobject/UpcomingRoadObject

UpcomingRoadObject

Holds the road objects and the distance to the start of the object. There are two sources of road objects: active route and the electronic horizon. Road objects coming from the electronic horizon will also have RoadObjectDistanceInfo Available RoadObjectDistanceInfo types are:

Parameters

roadObject

road object

distanceToStart

distance from current enhanced(matched) location to the start of the object along the current route. This value will be negative after passing the start of the object and until we cross the finish point of the RoadObjects geometry for objects that are on the actively navigated route, but it will be zero for EHorizon objects. It will be null if couldn't be determined.

distanceInfo

provides extra distance details for the road objects. It will be non-null for objects coming from the electronic horizon and null for objects that are on the current route that we are actively navigating on.

Functions

equals

open operator override fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

hashCode

open override fun hashCode(): Int

Returns a hash code value for the object.

toString

open override fun toString(): String

Returns a string representation of the object.

Properties

distanceInfo

val distanceInfo: RoadObjectDistanceInfo?

distanceToStart

val distanceToStart: Double?

roadObject

val roadObject: RoadObject