OnboardMapMatchingEngine

public class OnboardMapMatchingEngine : TomTomSDKNavigationEngine.MapMatchingEngine
extension OnboardMapMatchingEngine: OnStoreAccessChangedObserver

Map matching engine that uses an onboard map to match a raw location to the road network.

Important

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

Lifecycle

  • Initializer

    Declaration

    Swift

    public convenience init(store: MapDataStore) throws

    Parameters

    store

    The MapDataStore providing access to the onboard map to match the locations against.

Public

  • Function that provides a position matched to the road network.

    Declaration

    Swift

    public func matchLocation(navigationSnapshot: NavigationSnapshot) throws
    -> MapMatchingResult

    Parameters

    navigationSnapshot

    The snapshot of the current navigation session.

    Return Value

    A result with the matched location and it’s details

  • Function that attempts to extrapolate locations based on the previous position.

    Declaration

    Swift

    public func extrapolateLocation(navigationSnapshot: NavigationSnapshot) throws
    -> MapMatchingResult?

    Parameters

    navigationSnapshot

    The snapshot of the current navigation session.

    Return Value

    Matched location if possible. Otherwise returns nil.

  • Reset the engine. It hasn’t been implemented yet. This method does nothing

    Declaration

    Swift

    public func reset()

OnStoreAccessChangedObserver