data-management:onboard-nds-store/com.tomtom.sdk.datamanagement.nds/NdsStore

NdsStore

class NdsStore : DataStore, AutoCloseable

Implementation of a DataStore which is based on an onboard NDS map.

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

Types

Companion

object Companion

MapOperation

data class MapOperation(val operation: MapOperationType, val node: RegionGraphNodeId)

Represents an operation on the onboard map

Functions

addOnAutomaticUpdateFailureListener

fun addOnAutomaticUpdateFailureListener(listener: AutomaticUpdateFailureListener)

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

addOnUpdateListener

fun addOnUpdateListener(listener: UpdateListener)

Adds listener that is called when a region is successfully updated with new content.

addRegionGraphListener

fun addRegionGraphListener(listener: RegionGraphListener)

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

cancelAllMapOperations

fun cancelAllMapOperations(nodeIds: List<RegionGraphNodeId>)

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

open override fun close()

removeOnAutomaticUpdateFailureListener

fun removeOnAutomaticUpdateFailureListener(listener: AutomaticUpdateFailureListener)

Removes previously registered listener.

removeOnUpdateListener

fun removeOnUpdateListener(listener: UpdateListener)

Removes previously registered listener.

removeRegionGraphListener

fun removeRegionGraphListener(listener: RegionGraphListener)

Removes the given listener.

scheduleMapOperations

fun scheduleMapOperations(operations: List<NdsStore.MapOperation>)

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

setActiveRoute

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

Sets the active route.

setPosition

open override fun setPosition(position: GeoPoint)

Sets current position.

setUpdatesEnabled

fun setUpdatesEnabled(enabled: Boolean)

Enables or disables map updates.

Properties

storeAccess

open override val storeAccess: NdsStoreAccess

sync

val sync: NdsStoreAccessSync