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

MapMatchingResult

class MapMatchingResult(val matchedLocation: MatchedLocation, val rawLocation: GeoLocation, val alternativeMatchedLocations: List<MatchedLocation> = emptyList(), val followedRouteIds: List<RouteId> = emptyList())

Output of the map matching engine that represents accurate (map matched) location. This is used in driving mode to snap the chevron shown on the map to the road network. MapMatchingEngine provides an individual map matching result for each raw location.

Constructors

MapMatchingResult

constructor(matchedLocation: MatchedLocation, rawLocation: GeoLocation, locationPredictions: List<GeoLocation> = emptyList(), alternativeMatchedLocations: List<MatchedLocation> = emptyList(), followedRouteIds: List<RouteId> = emptyList())

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

constructor(matchedLocation: MatchedLocation, rawLocation: GeoLocation, alternativeMatchedLocations: List<MatchedLocation> = emptyList(), followedRouteIds: List<RouteId> = emptyList())

Properties

alternativeMatchedLocations

val alternativeMatchedLocations: List<MatchedLocation>

The list of alternative matched locations that were generated by the MapMatchingEngine. Can be empty.

followedRouteIds

val followedRouteIds: List<RouteId>

The list of route ids that were passed to the MapMatchingEngine and that the matchedLocation is on.

locationPredictions

var locationPredictions: List<GeoLocation>

The list of predicted locations that were generated by the MapMatchingEngine. They are useful when location updates from location service lag behind the current situation on the road. Can be empty.

matchedLocation

val matchedLocation: MatchedLocation

The best matched location candidate for the given raw location.

rawLocation

val rawLocation: GeoLocation

The original raw location that was passed to the MapMatchingEngine.

Functions

equals

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

Checks if this map matching result is equal to another object.

hashCode

open override fun hashCode(): Int

Generates a hash code for this map matching result.

toString

open override fun toString(): String

Returns a string representation of the map matching result.