Maria GDK 5.0.0.737
Documentation of native code in develop branch
Loading...
Searching...
No Matches
Maria::ExternalMapTileProvider Class Reference
Inheritance diagram for Maria::ExternalMapTileProvider:
Maria::IExternalMapTileProvider Maria::IMapTileProvider

Public Member Functions

 ExternalMapTileProvider (void *providerHandle, Maria::IExternalMapTileProvider::GetTileDataFunc getTileData, Maria::IExternalMapTileProvider::FreeGlobalBufferFunc freeGlobalBuffer, int maxQueueLength)
 
bool AddRequest (const MapContentQuery &request, FullTileId tileId, std::shared_ptr< ITileDataResponseTarget > responseTarget) override
 Add request to provider. Returns false if provider queue is full.
 
int PendingRequestCount (int tileCacheId=-1) const override
 Count of pending requests for specified tile cache.
 
void GetMapEntries (std::vector< MapEntry > &mapEntries) const override
 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.
 
FullTileId RemoveRequest (int tileCacheId, bool removeNewest) override
 Try to remove request from queue associated with a specific tile cache.
 
void SetMapEntries (const std::vector< MapEntry > &mapEntries) override
 
virtual void SetMapEntries (const std::vector< MapEntry > &mapEntries)=0
 
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.
 

Additional Inherited Members

- Public Types inherited from Maria::IExternalMapTileProvider
typedef void *(__cdecl * GetTileDataFunc) (void *provider, void *requestProto, int requestSize, int *resultLength)
 
typedef void *(__cdecl * FreeGlobalBufferFunc) (void *buffer)
 

Member Function Documentation

◆ AddRequest()

bool Maria::ExternalMapTileProvider::AddRequest ( const MapContentQuery request,
FullTileId  tileId,
std::shared_ptr< ITileDataResponseTarget responseTarget 
)
overridevirtual

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

Parameters
requestTile request
tileIdTile cache id and tile id of tile
responseTargetCall to process response from tile providers
Returns
true on success, false if unable to add request

Implements Maria::IMapTileProvider.

◆ GetMapEntries()

void Maria::ExternalMapTileProvider::GetMapEntries ( std::vector< MapEntry > &  mapEntries) const
overridevirtual

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
mapEntriesResult

Implements Maria::IMapTileProvider.

◆ PendingRequestCount()

int Maria::ExternalMapTileProvider::PendingRequestCount ( int  tileCacheId = -1) const
inlineoverridevirtual

Count of pending requests for specified tile cache.

Parameters
tileCacheIdTile cache id
Returns
Number of pending requests

Implements Maria::IMapTileProvider.

◆ RemoveRequest()

FullTileId ExternalMapTileProvider::RemoveRequest ( int  tileCacheId,
bool  removeNewest 
)
overridevirtual

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

Parameters
tileCacheIdTile cache id
removeNewestIf true, remove newest request. Of false, remove oldest request
Returns
Id of removed tile, InvalidTileId on failure

Implements Maria::IMapTileProvider.

◆ SetMapEntries()

void Maria::ExternalMapTileProvider::SetMapEntries ( const std::vector< MapEntry > &  mapEntries)
overridevirtual

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