Map

rpos::features::location_provider::Map Class

Base class of Map.

rpos/features/location_provider/map.h

/**
* Retrieves the area of the current map.
*/
rpos::core::RectangleF& getMapArea() const;

For details, please refer to rpos::core::RectangleF.

/**
* Retrieves the the upper-left point poistion of the map data. 
*/
rpos::core::Vector2f& getMapPosition() const;

For details, please refer to rpos::core::Vector2f.

/**
* Retrieves the pixel size (in X,Y dimensions) of the map.
*/
rpos::core::Vector2i& getMapDimension() const;

For details, please refer to rpos::core::Vector2i.

/**
* Retrieves the real world size of each cell (or pixel) of the map. In meter units.
*/
rpos::core::Vector2f& getMapResolution() const;

/**
* Retrieve the map updated timestamp.
*/
rpos::system::types::timestamp_t getMapTimestamp();

/**
* Retrieve the map data in raw byte stream.
*/
std::vector<_u8>& getMapData() const;

/**
* Retrieves the map type.
*/
MapType getMapType() const;

Return Value	Description	Related Class
`MapTypeBitmap8Bit`	The map is a grid map with each pixel is a 8bit cell	rpos::features::location_provider::BitmapMap
`MapTypePointmap`	Point map	rpos::features::location_provider::PointsMap

/**
* Read map data from the specified input stream.
*/
virtual bool readFromStream(rpos::system::io::IStream &in);

/**
* Write the map data from the specified output stream.
*/
virtual bool writeToStream(rpos::system::io::IStream &out) const;

/**
* Case the map object to its subclass type.
*/
template<class MapT> MapT cast();