NdsStore

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

An object of this class provides read-only access to the NDS map data.

Note: For accessing a specific map only one instance of the NdsStore class should be created.

Parameters

config

Parameters needed to configure NdsStore.

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object Companion

Properties

Link copied to clipboard
@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val geopoliticalView: String?

The country code in the ISO 3166-1 alpha-3 format whose view on disputed areas should be used. See NdsStoreConfiguration for more information.

Link copied to clipboard
@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val sync: NdsStoreAccessSync

Manages synchronized read/write access to the onboard NDS map. See NdsStoreAccessSync for more information.

Link copied to clipboard
@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val updater: NdsStoreUpdater?

Provides access to the NDS store updater.

Functions

Link copied to clipboard
open override fun close()
Link copied to clipboard

Provides access to the region updater. When not used, use RegionUpdater.close to release resources. For the first use, or after the previous instance was closed, a new RegionUpdater is instantiated.

Link copied to clipboard
fun replaceKeystore(newKeystoreFilePath: File, keystoreChecksum: String, callback: Callback<Unit, MapUpdateError>)

Replaces the current keystore with the specified file.

Link copied to clipboard
fun replaceMap(newMapDirectoryPath: File, newMapFileList: List<NewMapFile>?, callback: Callback<Unit, MapUpdateError>, progressReporter: (Int) -> Unit)

Replace the current onboard map with the given map.

Link copied to clipboard

Enables or disables map updates.