MapMatchingResult

public struct MapMatchingResult

The MapMatchingResult provides information about the matched location and its details.

Important

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

Lifecycle


                    
                    
                    init(location:predictions:routeMatchingDetails:mapPosition:)

Map matching result obtained from the MapMatchingEngine

Declaration

Swift

public init(
    location: GeoLocation,
    predictions: [GeoLocation] = [],
    routeMatchingDetails: RouteMatchingDetails = RouteMatchingDetails(followedRoutesIds: []),
    mapPosition: MapPosition? = nil
)

Parameters

`location`	The matched `GeoLocation`
`predictions`	The generated predictions
`routeMatchingDetails`	Route matching details containing followed routes
`mapPosition`	Position with map information


                    
                    
                    init(matchedLocation:timestamp:predictions:routeMatchingDetails:alternativeMatchedLocations:)

Map matching result obtained from the MapMatchingEngine

Declaration

Swift

public init(
    matchedLocation: MatchedLocation,
    timestamp: Measurement<UnitDuration> = .tt.seconds(0),
    predictions: [GeoLocation] = [],
    routeMatchingDetails: RouteMatchingDetails = RouteMatchingDetails(followedRoutesIds: []),
    alternativeMatchedLocations: [MatchedLocation] = []
)

Parameters

`matchedLocation`	The `MatchedLocation`
`timestamp`	Timestamp in ticks since reboot.
`routeMatchingDetails`	Route matching details containing followed routes
`alternativeMatchedLocations`	The alternative matched locations.

Public

matchedLocation
Contains the current matched location as well as predictions.
Declaration
Swift

public let matchedLocation: MatchedLocation
routeMatchingDetails
Contains details about the map matching result not related to location.
Declaration
Swift

public let routeMatchingDetails: RouteMatchingDetails
timestamp
The monotonic time since boot.
Declaration
Swift

public let timestamp: Measurement<UnitDuration>
alternativeMatchedLocations
List of alternative predictions
Declaration
Swift

public let alternativeMatchedLocations: [MatchedLocation]
predictions
The list of predicted locations.
Declaration
Swift

public let predictions: [GeoLocation]
geoLocation
The matched GeoLocation from matchedLocation
Declaration
Swift

public var geoLocation: GeoLocation { get }