Maria::IMapTileProviderCatalog Class Reference

Provides lookup for IMapTileProvider based providers given MapContentQuery. Used to determine the provider to use during tile data retrieval. More...

#include <MIMapTileProviderCatalog.h>

Inheritance diagram for Maria::IMapTileProviderCatalog:

Public Member Functions
virtual IMapTileProvider *	GetProvider (const MapContentQuery &mcq) const =0
	Get provider from MapContentQuery.
virtual void	AddProvider (std::shared_ptr< IMapTileProvider > provider)=0
	Add provider.
virtual bool	HasProvider (MapContentType wantedMapContentType) const =0
	Check if at least one provider exists for a given map content type.
virtual bool	ScanMapEntries (bool forceScan)=0
	Should be called periodically or when map entries of map data providers are changed.
virtual void	GetMapEntries (std::vector< MapEntry > &mapEntries) const =0
	Get all map entries.
virtual bool	GetMapEntry (const Maria::MapContentQuery &mcq, MapEntry &mapEntry) const =0
	Get map entry for a map content query.

Detailed Description

Provides lookup for IMapTileProvider based providers given MapContentQuery. Used to determine the provider to use during tile data retrieval.

Member Function Documentation

AddProvider()

virtual void Maria::IMapTileProviderCatalog::AddProvider ( std::shared_ptr< IMapTileProvider >  provider )

pure virtual

Add provider.

Parameters

provider

Implemented in Maria::MapTileProviderCatalog.

GetMapEntries()

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

pure virtual

Get all map entries.

Parameters

mapEntries

Result

Implemented in Maria::MapTileProviderCatalog.

GetMapEntry()

virtual bool Maria::IMapTileProviderCatalog::GetMapEntry ( const Maria::MapContentQuery &  mcq, MapEntry &  mapEntry  ) const

pure virtual

Get map entry for a map content query.

Parameters

mcq	Query
mapEntry	Result

Returns

true on success

Implemented in Maria::MapTileProviderCatalog.

GetProvider()

virtual IMapTileProvider * Maria::IMapTileProviderCatalog::GetProvider ( const MapContentQuery &  mcq ) const

pure virtual

Get provider from MapContentQuery.

Parameters

mcq	MapContentQuery used in lookup

Returns

Map tile provider, or nullptr on failure

Implemented in Maria::MapTileProviderCatalog.

HasProvider()

virtual bool Maria::IMapTileProviderCatalog::HasProvider ( MapContentType  wantedMapContentType ) const

pure virtual

Check if at least one provider exists for a given map content type.

Parameters

wantedMapContentType

Content type to query

Returns

Implemented in Maria::MapTileProviderCatalog.

ScanMapEntries()

virtual bool Maria::IMapTileProviderCatalog::ScanMapEntries ( bool  forceScan )

pure virtual

Should be called periodically or when map entries of map data providers are changed.

Parameters

forceScan

If true, scan will always be performed. If false, will only be called if some interval has passed

Returns

true if scan has been performed, otherwise false

Implemented in Maria::MapTileProviderCatalog.

---

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

• Native/MariaNative/MCommon/MIMapTileProviderCatalog.h