Maria::MapTileProviderCatalog Class Reference

Inheritance diagram for Maria::MapTileProviderCatalog:

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

Member Function Documentation

AddProvider()

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

overridevirtual

Add provider.

Parameters

provider

Implements Maria::IMapTileProviderCatalog.

GetMapEntries()

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

overridevirtual

Get all map entries.

Parameters

mapEntries

Result

Implements Maria::IMapTileProviderCatalog.

GetMapEntry()

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

overridevirtual

Get map entry for a map content query.

Parameters

mcq	Query
mapEntry	Result

Returns

true on success

Implements Maria::IMapTileProviderCatalog.

GetProvider()

Maria::IMapTileProvider * Maria::MapTileProviderCatalog::GetProvider ( const MapContentQuery &  mcq ) const

overridevirtual

Get provider from MapContentQuery.

Parameters

mcq	MapContentQuery used in lookup

Returns

Map tile provider, or nullptr on failure

Implements Maria::IMapTileProviderCatalog.

HasProvider()

bool Maria::MapTileProviderCatalog::HasProvider ( MapContentType  wantedMapContentType ) const

overridevirtual

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

Parameters

wantedMapContentType

Content type to query

Returns

Implements Maria::IMapTileProviderCatalog.

ScanMapEntries()

bool Maria::MapTileProviderCatalog::ScanMapEntries ( bool  forceScan )

overridevirtual

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

Implements Maria::IMapTileProviderCatalog.

---

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

• Native/MariaNative/MCommon/MMapTileProviderCatalog.h
• Native/MariaNative/MCommon/MMapTileProviderCatalog.cpp