YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Map2DStorage Class Reference

Map2DStorage: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device. More...

#include <map2DStorage/Map2DStorage.h>

+ Inheritance diagram for Map2DStorage:

Public Member Functions

 Map2DStorage ()
 Map2DStorage.
 
 ~Map2DStorage ()
 
bool open (yarp::os::Searchable &params) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
yarp::dev::ReturnValue clearAllMaps () override
 Removes all the registered maps from the server.
 
yarp::dev::ReturnValue store_map (const yarp::dev::Nav2D::MapGrid2D &map) override
 Stores a map into the map server.
 
yarp::dev::ReturnValue get_map (std::string map_name, yarp::dev::Nav2D::MapGrid2D &map) override
 Gets a map from the map server.
 
yarp::dev::ReturnValue get_map_names (std::vector< std::string > &map_names) override
 Gets a list containing the names of all registered maps.
 
yarp::dev::ReturnValue remove_map (std::string map_name) override
 Removes a map from the map server.
 
yarp::dev::ReturnValue storeObject (std::string object_name, yarp::dev::Nav2D::Map2DObject obj) override
 Store a object specified by the user in the world reference frame.
 
yarp::dev::ReturnValue storeLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation loc) override
 Store a location specified by the user in the world reference frame.
 
yarp::dev::ReturnValue storeArea (std::string area_name, yarp::dev::Nav2D::Map2DArea area) override
 Store an area.
 
yarp::dev::ReturnValue storePath (std::string path_name, yarp::dev::Nav2D::Map2DPath path) override
 Store a path.
 
yarp::dev::ReturnValue getObject (std::string object_name, yarp::dev::Nav2D::Map2DObject &obj) override
 Retrieves a object specified by the user in the world reference frame.
 
yarp::dev::ReturnValue getLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation &loc) override
 Retrieves a location specified by the user in the world reference frame.
 
yarp::dev::ReturnValue getArea (std::string area_name, yarp::dev::Nav2D::Map2DArea &area) override
 Retrieves an area.
 
yarp::dev::ReturnValue getPath (std::string path_name, yarp::dev::Nav2D::Map2DPath &path) override
 Retrieves a path.
 
yarp::dev::ReturnValue getObjectsList (std::vector< std::string > &locations) override
 Get a list of the names of all stored objects.
 
yarp::dev::ReturnValue getLocationsList (std::vector< std::string > &locations) override
 Get a list of the names of all stored locations.
 
yarp::dev::ReturnValue getAreasList (std::vector< std::string > &areas) override
 Get a list of the names of all stored areas.
 
yarp::dev::ReturnValue getPathsList (std::vector< std::string > &paths) override
 Get a list of the names of all stored paths.
 
yarp::dev::ReturnValue getAllObjects (std::vector< yarp::dev::Nav2D::Map2DObject > &obj) override
 Get a list of all stored objects.
 
yarp::dev::ReturnValue getAllLocations (std::vector< yarp::dev::Nav2D::Map2DLocation > &locations) override
 Get a list of all stored locations.
 
yarp::dev::ReturnValue getAllAreas (std::vector< yarp::dev::Nav2D::Map2DArea > &areas) override
 Get a list of all stored areas.
 
yarp::dev::ReturnValue getAllPaths (std::vector< yarp::dev::Nav2D::Map2DPath > &paths) override
 Get a list of all stored paths.
 
yarp::dev::ReturnValue renameObject (std::string original_name, std::string new_name) override
 Searches for a object and renames it.
 
yarp::dev::ReturnValue renameLocation (std::string original_name, std::string new_name) override
 Searches for a location and renames it.
 
yarp::dev::ReturnValue deleteObject (std::string object_name) override
 Delete an object.
 
yarp::dev::ReturnValue deleteLocation (std::string location_name) override
 Delete a location.
 
yarp::dev::ReturnValue deletePath (std::string path_name) override
 Delete a path.
 
yarp::dev::ReturnValue renameArea (std::string original_name, std::string new_name) override
 Searches for an area and renames it.
 
yarp::dev::ReturnValue renamePath (std::string original_name, std::string new_name) override
 Searches for a path and renames it.
 
yarp::dev::ReturnValue deleteArea (std::string area_name) override
 Delete an area.
 
yarp::dev::ReturnValue clearAllObjects () override
 Delete all stored objects.
 
yarp::dev::ReturnValue clearAllLocations () override
 Delete all stored locations.
 
yarp::dev::ReturnValue clearAllAreas () override
 Delete all stored areas.
 
yarp::dev::ReturnValue clearAllPaths () override
 Delete all stored paths.
 
yarp::dev::ReturnValue clearAllMapsTemporaryFlags () override
 Clear all temporary flags from all stored maps.
 
yarp::dev::ReturnValue clearMapTemporaryFlags (std::string map_name) override
 Clear all temporary flags from a specific map.
 
yarp::dev::ReturnValue saveMapToDisk (std::string map_name, std::string file_name) override
 Save a map to disk.
 
yarp::dev::ReturnValue loadMapFromDisk (std::string file_name) override
 Load a map from disk.
 
yarp::dev::ReturnValue saveMapsCollection (std::string maps_collection_file) override
 Save a collection of maps to disk.
 
yarp::dev::ReturnValue loadMapsCollection (std::string maps_collection_file) override
 Load a collection of maps from disk.
 
yarp::dev::ReturnValue reloadMapsCollection () override
 Reloads the last opened file containing the maps from disk.
 
yarp::dev::ReturnValue loadLocationsAndExtras (std::string locations_file) override
 Load a collection of locations/areas/paths etc from disk.
 
yarp::dev::ReturnValue saveLocationsAndExtras (std::string locations_file) override
 Save a collection of locations/area/paths etc to disk.
 
yarp::dev::ReturnValue reloadLocationsAndExtras () override
 Reloads the last opened file containing the collection of locations/areas/paths etc from disk.
 
yarp::dev::ReturnValue enableMapsCompression (bool enable) override
 Enable/disables maps compression over the network.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriver & operator= (const DeviceDriver &other)=delete
 
DeviceDriver & operator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDriver * getImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::dev::Nav2D::IMap2D
virtual ~IMap2D ()
 Destructor.
 
- Public Member Functions inherited from Map2DStorage_ParamsParser
 Map2DStorage_ParamsParser ()
 
 ~Map2DStorage_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Additional Inherited Members

- Public Attributes inherited from Map2DStorage_ParamsParser
const std::string m_device_classname = {"Map2DStorage"}
 
const std::string m_device_name = {"map2DStorage"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_name_defaultValue = {"/map2DStorage/rpc"}
 
const std::string m_mapCollectionContext_defaultValue = {""}
 
const std::string m_mapCollectionFile_defaultValue = {"maps_collection.ini"}
 
const std::string m_mapLocationsFile_defaultValue = {"locations.ini"}
 
std::string m_name = {"/map2DStorage/rpc"}
 
std::string m_mapCollectionContext = {}
 
std::string m_mapCollectionFile = {"maps_collection.ini"}
 
std::string m_mapLocationsFile = {"locations.ini"}
 

Detailed Description

Map2DStorage: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device.

Map2DStorage

Parameters required by this device are shown in class: Map2DStorage_ParamsParser

Definition at line 50 of file Map2DStorage.h.

Constructor & Destructor Documentation

◆ Map2DStorage()

Map2DStorage::Map2DStorage ( )

Map2DStorage.

Definition at line 44 of file Map2DStorage.cpp.

◆ ~Map2DStorage()

Map2DStorage::~Map2DStorage ( )
default

Member Function Documentation

◆ clearAllAreas()

ReturnValue Map2DStorage::clearAllAreas ( )
overridevirtual

Delete all stored areas.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1285 of file Map2DStorage.cpp.

◆ clearAllLocations()

ReturnValue Map2DStorage::clearAllLocations ( )
overridevirtual

Delete all stored locations.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1279 of file Map2DStorage.cpp.

◆ clearAllMaps()

ReturnValue Map2DStorage::clearAllMaps ( )
overridevirtual

Removes all the registered maps from the server.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1018 of file Map2DStorage.cpp.

◆ clearAllMapsTemporaryFlags()

ReturnValue Map2DStorage::clearAllMapsTemporaryFlags ( )
overridevirtual

Clear all temporary flags from all stored maps.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1297 of file Map2DStorage.cpp.

◆ clearAllObjects()

yarp::dev::ReturnValue Map2DStorage::clearAllObjects ( )
overridevirtual

Delete all stored objects.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1482 of file Map2DStorage.cpp.

◆ clearAllPaths()

ReturnValue Map2DStorage::clearAllPaths ( )
overridevirtual

Delete all stored paths.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1291 of file Map2DStorage.cpp.

◆ clearMapTemporaryFlags()

ReturnValue Map2DStorage::clearMapTemporaryFlags ( std::string  map_name)
overridevirtual

Clear all temporary flags from a specific map.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1306 of file Map2DStorage.cpp.

◆ close()

bool Map2DStorage::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 286 of file Map2DStorage.cpp.

◆ deleteArea()

ReturnValue Map2DStorage::deleteArea ( std::string  area_name)
overridevirtual

Delete an area.

Parameters
area_namethe name of the area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1215 of file Map2DStorage.cpp.

◆ deleteLocation()

ReturnValue Map2DStorage::deleteLocation ( std::string  location_name)
overridevirtual

Delete a location.

Parameters
location_namethe name of the location
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1203 of file Map2DStorage.cpp.

◆ deleteObject()

yarp::dev::ReturnValue Map2DStorage::deleteObject ( std::string  object_name)
overridevirtual

Delete an object.

Parameters
object_namethe name of the location
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1470 of file Map2DStorage.cpp.

◆ deletePath()

ReturnValue Map2DStorage::deletePath ( std::string  path_name)
overridevirtual

Delete a path.

Parameters
path_namethe name of the path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1227 of file Map2DStorage.cpp.

◆ enableMapsCompression()

ReturnValue Map2DStorage::enableMapsCompression ( bool  enable)
overridevirtual

Enable/disables maps compression over the network.

Parameters
enable
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1397 of file Map2DStorage.cpp.

◆ get_map()

ReturnValue Map2DStorage::get_map ( std::string  map_name,
yarp::dev::Nav2D::MapGrid2D &  map 
)
overridevirtual

Gets a map from the map server.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1041 of file Map2DStorage.cpp.

◆ get_map_names()

ReturnValue Map2DStorage::get_map_names ( std::vector< std::string > &  map_names)
overridevirtual

Gets a list containing the names of all registered maps.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1052 of file Map2DStorage.cpp.

◆ getAllAreas()

ReturnValue Map2DStorage::getAllAreas ( std::vector< yarp::dev::Nav2D::Map2DArea > &  areas)
overridevirtual

Get a list of all stored areas.

Parameters
thereturned list of areas
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1166 of file Map2DStorage.cpp.

◆ getAllLocations()

ReturnValue Map2DStorage::getAllLocations ( std::vector< yarp::dev::Nav2D::Map2DLocation > &  locations)
overridevirtual

Get a list of all stored locations.

Parameters
thereturned list of locations
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1156 of file Map2DStorage.cpp.

◆ getAllObjects()

yarp::dev::ReturnValue Map2DStorage::getAllObjects ( std::vector< yarp::dev::Nav2D::Map2DObject > &  obj)
overridevirtual

Get a list of all stored objects.

Parameters
thereturned list of objects
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1445 of file Map2DStorage.cpp.

◆ getAllPaths()

ReturnValue Map2DStorage::getAllPaths ( std::vector< yarp::dev::Nav2D::Map2DPath > &  paths)
overridevirtual

Get a list of all stored paths.

Parameters
thereturned list of paths
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1175 of file Map2DStorage.cpp.

◆ getArea()

ReturnValue Map2DStorage::getArea ( std::string  area_name,
yarp::dev::Nav2D::Map2DArea &  area 
)
overridevirtual

Retrieves an area.

Parameters
area_namethe name of the area
areathe area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1104 of file Map2DStorage.cpp.

◆ getAreasList()

ReturnValue Map2DStorage::getAreasList ( std::vector< std::string > &  areas)
overridevirtual

Get a list of the names of all stored areas.

Parameters
thereturned list of areas names
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1136 of file Map2DStorage.cpp.

◆ getLocation()

ReturnValue Map2DStorage::getLocation ( std::string  location_name,
yarp::dev::Nav2D::Map2DLocation &  loc 
)
overridevirtual

Retrieves a location specified by the user in the world reference frame.

Parameters
location_namethe name of the location
locthe location
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1093 of file Map2DStorage.cpp.

◆ getLocationsList()

ReturnValue Map2DStorage::getLocationsList ( std::vector< std::string > &  locations)
overridevirtual

Get a list of the names of all stored locations.

Parameters
thereturned list of locations names
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1126 of file Map2DStorage.cpp.

◆ getObject()

yarp::dev::ReturnValue Map2DStorage::getObject ( std::string  object_name,
yarp::dev::Nav2D::Map2DObject &  obj 
)
overridevirtual

Retrieves a object specified by the user in the world reference frame.

Parameters
object_namethe name of the location
objthe location
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1422 of file Map2DStorage.cpp.

◆ getObjectsList()

yarp::dev::ReturnValue Map2DStorage::getObjectsList ( std::vector< std::string > &  objects)
overridevirtual

Get a list of the names of all stored objects.

Parameters
thereturned list of objects names
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1434 of file Map2DStorage.cpp.

◆ getPath()

ReturnValue Map2DStorage::getPath ( std::string  path_name,
yarp::dev::Nav2D::Map2DPath &  path 
)
overridevirtual

Retrieves a path.

Parameters
path_namethe name of the path
paththe path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1115 of file Map2DStorage.cpp.

◆ getPathsList()

ReturnValue Map2DStorage::getPathsList ( std::vector< std::string > &  paths)
overridevirtual

Get a list of the names of all stored paths.

Parameters
thereturned list of paths names
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1146 of file Map2DStorage.cpp.

◆ loadLocationsAndExtras()

ReturnValue Map2DStorage::loadLocationsAndExtras ( std::string  file_name)
overridevirtual

Load a collection of locations/areas/paths etc from disk.

Parameters
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 858 of file Map2DStorage.cpp.

◆ loadMapFromDisk()

ReturnValue Map2DStorage::loadMapFromDisk ( std::string  file_name)
overridevirtual

Load a map from disk.

Parameters
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1369 of file Map2DStorage.cpp.

◆ loadMapsCollection()

ReturnValue Map2DStorage::loadMapsCollection ( std::string  file_name)
overridevirtual

Load a collection of maps from disk.

Parameters
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 93 of file Map2DStorage.cpp.

◆ open()

bool Map2DStorage::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 163 of file Map2DStorage.cpp.

◆ reloadLocationsAndExtras()

yarp::dev::ReturnValue Map2DStorage::reloadLocationsAndExtras ( )
overridevirtual

Reloads the last opened file containing the collection of locations/areas/paths etc from disk.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1494 of file Map2DStorage.cpp.

◆ reloadMapsCollection()

yarp::dev::ReturnValue Map2DStorage::reloadMapsCollection ( )
overridevirtual

Reloads the last opened file containing the maps from disk.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1489 of file Map2DStorage.cpp.

◆ remove_map()

ReturnValue Map2DStorage::remove_map ( std::string  map_name)
overridevirtual

Removes a map from the map server.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1062 of file Map2DStorage.cpp.

◆ renameArea()

ReturnValue Map2DStorage::renameArea ( std::string  original_name,
std::string  new_name 
)
overridevirtual

Searches for an area and renames it.

Parameters
original_namethe name of the area
new_namethe new name of the area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1239 of file Map2DStorage.cpp.

◆ renameLocation()

ReturnValue Map2DStorage::renameLocation ( std::string  original_name,
std::string  new_name 
)
overridevirtual

Searches for a location and renames it.

Parameters
original_namethe name of the area
new_namethe new name of the area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1185 of file Map2DStorage.cpp.

◆ renameObject()

yarp::dev::ReturnValue Map2DStorage::renameObject ( std::string  original_name,
std::string  new_name 
)
overridevirtual

Searches for a object and renames it.

Parameters
original_namethe name of the area
new_namethe new name of the area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1456 of file Map2DStorage.cpp.

◆ renamePath()

ReturnValue Map2DStorage::renamePath ( std::string  original_name,
std::string  new_name 
)
overridevirtual

Searches for a path and renames it.

Parameters
original_namethe name of the path
new_namethe new name of the path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1258 of file Map2DStorage.cpp.

◆ saveLocationsAndExtras()

ReturnValue Map2DStorage::saveLocationsAndExtras ( std::string  file_name)
overridevirtual

Save a collection of locations/area/paths etc to disk.

Parameters
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 933 of file Map2DStorage.cpp.

◆ saveMapsCollection()

ReturnValue Map2DStorage::saveMapsCollection ( std::string  file_name)
overridevirtual

Save a collection of maps to disk.

Parameters
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 50 of file Map2DStorage.cpp.

◆ saveMapToDisk()

ReturnValue Map2DStorage::saveMapToDisk ( std::string  map_name,
std::string  file_name 
)
overridevirtual

Save a map to disk.

Parameters
map_namethe name of the area
file_namefile name with full path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1344 of file Map2DStorage.cpp.

◆ store_map()

ReturnValue Map2DStorage::store_map ( const yarp::dev::Nav2D::MapGrid2D &  map)
overridevirtual

Stores a map into the map server.

Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1024 of file Map2DStorage.cpp.

◆ storeArea()

ReturnValue Map2DStorage::storeArea ( std::string  area_name,
yarp::dev::Nav2D::Map2DArea  area 
)
overridevirtual

Store an area.

Parameters
area_namethe name of the area
areathe area
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1081 of file Map2DStorage.cpp.

◆ storeLocation()

ReturnValue Map2DStorage::storeLocation ( std::string  location_name,
yarp::dev::Nav2D::Map2DLocation  loc 
)
overridevirtual

Store a location specified by the user in the world reference frame.

Parameters
location_namethe name of the location
locthe location of the location
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1075 of file Map2DStorage.cpp.

◆ storeObject()

yarp::dev::ReturnValue Map2DStorage::storeObject ( std::string  object_name,
yarp::dev::Nav2D::Map2DObject  obj 
)
overridevirtual

Store a object specified by the user in the world reference frame.

Parameters
object_namethe name of the location
objthe location of the object
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1415 of file Map2DStorage.cpp.

◆ storePath()

ReturnValue Map2DStorage::storePath ( std::string  path_name,
yarp::dev::Nav2D::Map2DPath  path 
)
overridevirtual

Store a path.

Parameters
path_namethe name of the path
paththe path
Returns
a ReturnValue, convertible to true/false

Implements yarp::dev::Nav2D::IMap2D.

Definition at line 1087 of file Map2DStorage.cpp.


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