com.tomtom.sdk.datamanagement:nds-store-updater/com.tomtom.sdk.datamanagement.nds.update/NdsStoreUpdater

NdsStoreUpdater

class NdsStoreUpdater : NdsMapUpdater, AutoCloseable

Implementation of an NDS data store updater.

An object of this class provides write access to the NDS map data with ability to enabling automatic map updates, managing map regions and querying map structures.

Note: For the same NdsStore only one instance of the NdsStoreUpdater class should be created.

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

Types

Companion

object Companion

Properties

ndsMapAccessSync

open override val ndsMapAccessSync: NdsStoreAccessSync

ndsMapPath

open override val ndsMapPath: File

Functions

activateAutomaticUpdates

fun activateAutomaticUpdates(activate: Boolean)

Activates or deactivates automatic updates.

addAutomaticMapUpdateFailureListener

fun addAutomaticMapUpdateFailureListener(listener: AutomaticMapUpdateFailureListener)

Adds listener that is called when an automatic update fails due to an irrecoverable error.

addMapUpdateAvailabilityCheckListener

fun addMapUpdateAvailabilityCheckListener(listener: MapUpdateAvailabilityCheckListener)

Add a listener for information about when the map update server is checked for new updates.

addRegionGraphListener

fun addRegionGraphListener(listener: RegionGraphListener)

Add a listener for information about the region graph and state of the map.

calculateUninstallSize

fun calculateUninstallSize(regions: Set<RegionGraphNodeId>, callback: Callback<Memory, MapUpdateError>): Cancellable

Calculates the uninstallation size of the specified regions.

cancelAllMapOperations

fun cancelAllMapOperations(nodeIds: List<RegionGraphNodeId>)

Requests cancellation of all operations scheduled with scheduleMapOperations for the specified updatable regions.

open override fun close()

findRegionsAlongPolyline

fun findRegionsAlongPolyline(polyline: List<GeoPoint>, radius: Distance, callback: Callback<RegionsAlongPolyline, MapUpdateError>): Cancellable

Finds the updatable regions along a polyline within a half-corridor width radius.

findRegionsAroundPosition

fun findRegionsAroundPosition(position: GeoPoint, radius: Distance, callback: Callback<RegionsAroundPosition, MapUpdateError>): Cancellable

Finds the updatable regions within radius of position.

removeAutomaticMapUpdateFailureListener

fun removeAutomaticMapUpdateFailureListener(listener: AutomaticMapUpdateFailureListener)

Removes previously registered listener.

removeMapUpdateAvailabilityCheckListener

fun removeMapUpdateAvailabilityCheckListener(listener: MapUpdateAvailabilityCheckListener)

Removes the given listener.

removeRegionGraphListener

fun removeRegionGraphListener(listener: RegionGraphListener)

Removes the given listener.

scheduleMapOperations

fun scheduleMapOperations(operations: List<MapOperation>)

Schedules the given operations to be performed on the onboard map.

setUpdatesEnabled

fun setUpdatesEnabled(updatesEnabled: Boolean)

Enables or disables map updates.

updateActiveRoute

open override fun updateActiveRoute(polyline: List<GeoPoint>)

Sets the active route.

updatePosition

open override fun updatePosition(position: GeoPoint)

Sets current position.