Maria::IMapTileProvider Class Reference

Interface for native map tile providers. Used by MapTileProviderCatalog and TileDataProcessor to provide data to map tiles and tile caches. More...

#include <MIMapTileProvider.h>

Inheritance diagram for Maria::IMapTileProvider:

Public Member Functions
virtual bool	AddRequest (const MapContentQuery &request, FullTileId tileId, std::shared_ptr< ITileDataResponseTarget > responseTarget)=0
	Add request to provider. Returns false if provider queue is full.
virtual FullTileId	RemoveRequest (int tileCacheId, bool removeNewest=false)=0
	Try to remove request from queue associated with a specific tile cache.
virtual int	PendingRequestCount (int tileCacheId=-1) const =0
	Count of pending requests for specified tile cache.
virtual void	GetMapEntries (std::vector< MapEntry > &mapEntries) const =0
	Get all map entries served by the provider. Note that if "*" is set as map signature, the provider can provide data for map signatures of given map type.

Detailed Description

Interface for native map tile providers. Used by MapTileProviderCatalog and TileDataProcessor to provide data to map tiles and tile caches.

Member Function Documentation

AddRequest()

virtual bool Maria::IMapTileProvider::AddRequest ( const MapContentQuery &  request, FullTileId  tileId, std::shared_ptr< ITileDataResponseTarget >  responseTarget  )

pure virtual

Add request to provider. Returns false if provider queue is full.

Parameters

request	Tile request
tileId	Tile cache id and tile id of tile
responseTarget	Call to process response from tile providers

Returns

true on success, false if unable to add request

Implemented in Maria::ElevationMapProvider, Maria::NormalMapProvider, Maria::ExternalMapTileProvider, Maria::FileMapDataProvider, and Maria::HttpMapDataProvider.

GetMapEntries()

virtual void Maria::IMapTileProvider::GetMapEntries ( std::vector< MapEntry > &  mapEntries ) const

pure virtual

Get all map entries served by the provider. Note that if "*" is set as map signature, the provider can provide data for map signatures of given map type.

Parameters

mapEntries

Result

Implemented in Maria::ElevationMapProvider, Maria::NormalMapProvider, Maria::ExternalMapTileProvider, Maria::FileMapDataProvider, and Maria::HttpMapDataProvider.

PendingRequestCount()

virtual int Maria::IMapTileProvider::PendingRequestCount ( int  tileCacheId = -1 ) const

pure virtual

Count of pending requests for specified tile cache.

Parameters

tileCacheId

Tile cache id

Returns

Number of pending requests

Implemented in Maria::ElevationMapProvider, Maria::NormalMapProvider, Maria::ExternalMapTileProvider, Maria::FileMapDataProvider, and Maria::HttpMapDataProvider.

RemoveRequest()

virtual FullTileId Maria::IMapTileProvider::RemoveRequest ( int  tileCacheId, bool  removeNewest = false  )

pure virtual

Try to remove request from queue associated with a specific tile cache.

Parameters

tileCacheId	Tile cache id
removeNewest	If true, remove newest request. Of false, remove oldest request

Returns

Id of removed tile, InvalidTileId on failure

Implemented in Maria::ExternalMapTileProvider, Maria::HttpMapDataProvider, Maria::ElevationMapProvider, Maria::NormalMapProvider, and Maria::FileMapDataProvider.

---

The documentation for this class was generated from the following file:

• Native/MariaNative/MCommon/MIMapTileProvider.h