LocationMatcherResult

class LocationMatcherResult

Provides information about the status of the enhanced location updates generated by the map matching engine of the Navigation SDK.

Parameters

enhancedLocation

the best possible location update, snapped to the route or map matched to the road if possible.

keyPoints

a list (can be empty) of predicted location points leading up to the target update. The last point on the list (if not empty) is always equal to enhancedLocation.

isOffRoad

whether the SDK thinks that the user is off road, based on the offRoadProbability.

offRoadProbability

probability that the user is off road.

isTeleport

returns true if map matcher changed its opinion about most probable path on last update. In practice it means we don't need to animate puck movement from previous to current location and just do an immediate transition instead.

speedLimit

current speed limit during free drive and active navigation session. In order to receive the speed limit make sure you add annotationsList with DirectionsCriteria.ANNOTATION_MAXSPEED annotation to the route request.

roadEdgeMatchProbability

when map matcher snaps to a road, this is the confidence in the chosen edge from all nearest edges.

zLevel

Int current Z-level. Can be used to build a route from a proper level of a road.

road

Road can be used to get information about the Road including name, shield name and shield url.

isDegradedMapMatching

whether map matching was running in "degraded" mode, i.e. can have worse quality(usually happens due to the lack of map data). In practice "degraded" mode means raw location in free drive and worse off-route experience in case of route set.

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Returns a hash code value for the object.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

enhancedLocation
Link copied to clipboard
val enhancedLocation: Location
the best possible location update, snapped to the route or map matched to the road if possible.
isDegradedMapMatching
Link copied to clipboard
val isDegradedMapMatching: Boolean
whether map matching was running in "degraded" mode, i.e.
isOffRoad
Link copied to clipboard
val isOffRoad: Boolean
whether the SDK thinks that the user is off road, based on the offRoadProbability.
isTeleport
Link copied to clipboard
val isTeleport: Boolean
returns true if map matcher changed its opinion about most probable path on last update.
keyPoints
Link copied to clipboard
val keyPoints: List<Location>
a list (can be empty) of predicted location points leading up to the target update.
offRoadProbability
Link copied to clipboard
val offRoadProbability: Float
probability that the user is off road.
road
Link copied to clipboard
val road: Road
Road can be used to get information about the Road including name, shield name and shield url.
roadEdgeMatchProbability
Link copied to clipboard
val roadEdgeMatchProbability: Float
when map matcher snaps to a road, this is the confidence in the chosen edge from all nearest edges.
speedLimit
Link copied to clipboard
val speedLimit: SpeedLimit?
current speed limit during free drive and active navigation session.
zLevel
Link copied to clipboard
val zLevel: Int?
Int current Z-level.