Maria GDK 5.0.0.910
Documentation of native code in develop branch
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Maria::IMapDataProvider Class Referenceabstract

#include <MIMapDataProvider.h>

Inheritance diagram for Maria::IMapDataProvider:
Maria::DrawObjectTileProvider Maria::ElevationMapProvider Maria::FileMapDataProvider Maria::HttpMapDataProvider Maria::NormalMapProvider

Public Member Functions

virtual int GetFlags ()
 
virtual bool GetMapEntry (const MapContentQuery &mapQuery, Maria::MapEntry &mapEntry, unsigned long timeout=0)=0
 
virtual std::shared_ptr< MariaProtobuf::FetchMapReplyMessage > GetTileData (const GenerateMapTileRequest &req, unsigned long timeout_ms=0)=0
 
virtual void GetMapEntries (std::vector< MapEntry > &mapEntries) const =0
 

Detailed Description

IMapDataProvider - Interface for low-level map data providers

Member Function Documentation

◆ GetMapEntries()

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

Get a list of map entries available to this data provider.

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

◆ GetMapEntry()

virtual bool Maria::IMapDataProvider::GetMapEntry ( const MapContentQuery &  mapQuery,
Maria::MapEntry &  mapEntry,
unsigned long  timeout = 0 
)
pure virtual

Get a map catalog entry from a map query. This method should fill out the provided mapEntry with the resolved data for the given mapQuery.

The method should return true on success, and false on failure.

The method should block until a response can be given, but at most timeout ms. If timeout = 0, it may block indefinitely.

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

◆ GetTileData()

virtual std::shared_ptr< MariaProtobuf::FetchMapReplyMessage > Maria::IMapDataProvider::GetTileData ( const GenerateMapTileRequest &  req,
unsigned long  timeout_ms = 0 
)
pure virtual

Get map tile data from map query. This method should return a FetchMapReply with tile data or a valid error code for the given mapQuery.

The method should block until a response can be given, but at most timeout ms. If timeout = 0, it may block indefinitely.

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

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