com.tomtom.sdk.datamanagement:navigation-tile-store/com.tomtom.sdk.datamanagement.navigationtile/PrefetchingConfiguration

PrefetchingConfiguration

class PrefetchingConfiguration(val prefetchedAreaRadius: Distance = DEFAULT_RADIUS, val shouldRequestLaneTiles: Boolean = false)

Configuration parameters for prefetching navigation map data. It defines area around the current position or around the active route for which navigation map data is prefetched and kept available in NavigationTileStore. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost.

Constructors

constructor(prefetchedAreaRadius: Distance = DEFAULT_RADIUS, shouldRequestLaneTiles: Boolean = false, prefetchedAreaAlongRoute: AreaAlongRoute? = DEFAULT_AREA_ALONG_ROUTE)

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

constructor(prefetchedAreaRadius: Distance = DEFAULT_RADIUS, shouldRequestLaneTiles: Boolean = false)

Creates a new PrefetchingConfiguration.

Types

Companion

object Companion

Properties

prefetchedAreaAlongRoute

var prefetchedAreaAlongRoute: AreaAlongRoute?

Important: This is a Public Preview API. It may be changed or removed at any time. Area along the active route to prefetch navigation map data and keep it available. If the parameter is omitted, the default area along the active route will be used. If the parameter is set to null, NO navigation map data along the active route will be prefetched. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. The parameter defaults to DEFAULT_AREA_ALONG_ROUTE meters. WARNING: This parameter has effect only with NdsLiveFeature feature toggle enabled.

prefetchedAreaRadius

val prefetchedAreaRadius: Distance

Radius around the current position defining the minimum area for which navigation map data is prefetched and kept available. The actual area fetched can be greater than the requested radius. The larger the radius, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost. The value must be non-negative integer. The parameter defaults to DEFAULT_RADIUS meters.

shouldRequestLaneTiles

val shouldRequestLaneTiles: Boolean = false

The setting enabling access to lane tiles in the navigation tiles. When value is true lane level visualization can display the road network with enhanced lane geometry. The parameter defaults to false. WARNING: enabling lane tiles will result in increased data consumption.

Functions

copy

fun copy(prefetchedAreaRadius: Distance = this.prefetchedAreaRadius, shouldRequestLaneTiles: Boolean = this.shouldRequestLaneTiles): PrefetchingConfiguration

Creates a copy of this PrefetchingConfiguration object with optional parameter overrides.

fun copy(prefetchedAreaRadius: Distance = this.prefetchedAreaRadius, shouldRequestLaneTiles: Boolean = this.shouldRequestLaneTiles, prefetchedAreaAlongRoute: AreaAlongRoute? = this.prefetchedAreaAlongRoute): PrefetchingConfiguration

Important: This is a Public Preview API. It may be changed or removed at any time. Creates a copy of this PrefetchingConfiguration object with optional parameter overrides.

equals

open operator override fun equals(other: Any?): Boolean

Checks if this PrefetchingConfiguration object is equal to another object.

hashCode

open override fun hashCode(): Int

Generates a hash code for this PrefetchingConfiguration object.

toString

open override fun toString(): String

Returns a string representation of the object.