gem::MapDownloaderService Class Reference

MapDownloaderService object. More...

Inheritance diagram for gem::MapDownloaderService:

Collaboration diagram for gem::MapDownloaderService:

Public Member Functions
int	getMaxSquareKm () noexcept
	Get the maximum area size in square kilometers to download.
MapDownloaderService &	setMaxSquareKm (int maxSquareKm) noexcept
	Set the maximum area size in square kilometers to download.
int	startDownload (const List< RectangleGeographicArea > &areas, ProgressListener progressListener) noexcept
	Download tiles for the given area.
void	cancelDownload () noexcept
	Cancel a previously started download.
TransferStatisticsRef	getTransferStatistics () const noexcept
	Get data transfer statistics for this service.

Detailed Description

MapDownloaderService object.

Implements Api object over IMapDownloaderService.

Downloads and manages offline map data.

Handles background downloading, updates, and storage of regional map packages to support offline navigation and rendering.

Member Function Documentation

cancelDownload()

void gem::MapDownloaderService::cancelDownload ( )

inlinenoexcept

Cancel a previously started download.

This method is asynchronous, the progress listener should wait for a NotifyComplete event.

getMaxSquareKm()

int gem::MapDownloaderService::getMaxSquareKm ( )

inlinenoexcept

Get the maximum area size in square kilometers to download.

If the area size is greater than this value, startDownload will fail.

Returns

The maximum area size in square kilometers

getTransferStatistics()

TransferStatisticsRef gem::MapDownloaderService::getTransferStatistics ( ) const

inlinenoexcept

Get data transfer statistics for this service.

Returns

The transfer statistics

setMaxSquareKm()

MapDownloaderService & gem::MapDownloaderService::setMaxSquareKm ( int maxSquareKm )

inlinenoexcept

Set the maximum area size in square kilometers to download.

If the area size is greater than this value, startDownload will fail.

Parameters

maxSquareKm

The maximum area size in square kilometers

Returns

A reference to the object

startDownload()

int gem::MapDownloaderService::startDownload ( const List< RectangleGeographicArea > & areas, ProgressListener progressListener )

inlinenoexcept

Download tiles for the given area.

This method is asynchronous and should always be called with a progress listener

Parameters

areas	The areas to download
progressListener	The progress listener

Returns

Operation error code