com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.mapmatching/MatchedLocation

MatchedLocation

class MatchedLocation(val location: GeoLocation, val id: Int, val probability: Probability, val isOnRoad: Boolean, val direction: Angle)

Part of the map matching result that represents a single matched position candidate.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

MatchedLocation

constructor(location: GeoLocation, id: Int, probability: Probability, isOnRoad: Boolean, direction: Angle)

Properties

direction

val direction: Angle

The direction of the line segment on which the location is matched in degrees clockwise from North. It can be either the input heading from MapMatchingResult.rawLocation, or the direction of the closest road.

val id: Int

Identifier of the matched position candidate. For the best matches the id will change when the map matcher detects a matching error and applies correction. For the alternative matches the behavior depends on the underlying matching algorithm and is generally not guaranteed.

isOnRoad

val isOnRoad: Boolean

The flag indicating whether the matched position candidate is on the road.

location

val location: GeoLocation

The location that was matched on the map.

probability

val probability: Probability

The score of the matched position in range 0-100.