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 ¶ms) 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 ¶mName, std::string ¶mValue) 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"} |
Map2DStorage: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device.
Parameters required by this device are shown in class: Map2DStorage_ParamsParser
Definition at line 50 of file Map2DStorage.h.
| Map2DStorage::Map2DStorage | ( | ) |
Definition at line 44 of file Map2DStorage.cpp.
|
default |
|
overridevirtual |
Delete all stored areas.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1285 of file Map2DStorage.cpp.
|
overridevirtual |
Delete all stored locations.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1279 of file Map2DStorage.cpp.
|
overridevirtual |
Removes all the registered maps from the server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1018 of file Map2DStorage.cpp.
|
overridevirtual |
Clear all temporary flags from all stored maps.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1297 of file Map2DStorage.cpp.
|
overridevirtual |
Delete all stored objects.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1482 of file Map2DStorage.cpp.
|
overridevirtual |
Delete all stored paths.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1291 of file Map2DStorage.cpp.
|
overridevirtual |
Clear all temporary flags from a specific map.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1306 of file Map2DStorage.cpp.
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 286 of file Map2DStorage.cpp.
|
overridevirtual |
Delete an area.
| area_name | the name of the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1215 of file Map2DStorage.cpp.
|
overridevirtual |
Delete a location.
| location_name | the name of the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1203 of file Map2DStorage.cpp.
|
overridevirtual |
Delete an object.
| object_name | the name of the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1470 of file Map2DStorage.cpp.
|
overridevirtual |
Delete a path.
| path_name | the name of the path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1227 of file Map2DStorage.cpp.
|
overridevirtual |
Enable/disables maps compression over the network.
| enable |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1397 of file Map2DStorage.cpp.
|
overridevirtual |
Gets a map from the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1041 of file Map2DStorage.cpp.
|
overridevirtual |
Gets a list containing the names of all registered maps.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1052 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of all stored areas.
| the | returned list of areas |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1166 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of all stored locations.
| the | returned list of locations |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1156 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of all stored objects.
| the | returned list of objects |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1445 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of all stored paths.
| the | returned list of paths |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1175 of file Map2DStorage.cpp.
|
overridevirtual |
Retrieves an area.
| area_name | the name of the area |
| area | the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1104 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of the names of all stored areas.
| the | returned list of areas names |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1136 of file Map2DStorage.cpp.
|
overridevirtual |
Retrieves a location specified by the user in the world reference frame.
| location_name | the name of the location |
| loc | the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1093 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of the names of all stored locations.
| the | returned list of locations names |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1126 of file Map2DStorage.cpp.
|
overridevirtual |
Retrieves a object specified by the user in the world reference frame.
| object_name | the name of the location |
| obj | the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1422 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of the names of all stored objects.
| the | returned list of objects names |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1434 of file Map2DStorage.cpp.
|
overridevirtual |
Retrieves a path.
| path_name | the name of the path |
| path | the path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1115 of file Map2DStorage.cpp.
|
overridevirtual |
Get a list of the names of all stored paths.
| the | returned list of paths names |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1146 of file Map2DStorage.cpp.
|
overridevirtual |
Load a collection of locations/areas/paths etc from disk.
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 858 of file Map2DStorage.cpp.
|
overridevirtual |
Load a map from disk.
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1369 of file Map2DStorage.cpp.
|
overridevirtual |
Load a collection of maps from disk.
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 93 of file Map2DStorage.cpp.
|
overridevirtual |
Open the DeviceDriver.
| config | is 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). |
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 163 of file Map2DStorage.cpp.
|
overridevirtual |
Reloads the last opened file containing the collection of locations/areas/paths etc from disk.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1494 of file Map2DStorage.cpp.
|
overridevirtual |
Reloads the last opened file containing the maps from disk.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1489 of file Map2DStorage.cpp.
|
overridevirtual |
Removes a map from the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1062 of file Map2DStorage.cpp.
|
overridevirtual |
Searches for an area and renames it.
| original_name | the name of the area |
| new_name | the new name of the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1239 of file Map2DStorage.cpp.
|
overridevirtual |
Searches for a location and renames it.
| original_name | the name of the area |
| new_name | the new name of the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1185 of file Map2DStorage.cpp.
|
overridevirtual |
Searches for a object and renames it.
| original_name | the name of the area |
| new_name | the new name of the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1456 of file Map2DStorage.cpp.
|
overridevirtual |
Searches for a path and renames it.
| original_name | the name of the path |
| new_name | the new name of the path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1258 of file Map2DStorage.cpp.
|
overridevirtual |
Save a collection of locations/area/paths etc to disk.
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 933 of file Map2DStorage.cpp.
|
overridevirtual |
Save a collection of maps to disk.
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 50 of file Map2DStorage.cpp.
|
overridevirtual |
Save a map to disk.
| map_name | the name of the area |
| file_name | file name with full path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1344 of file Map2DStorage.cpp.
|
overridevirtual |
Stores a map into the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1024 of file Map2DStorage.cpp.
|
overridevirtual |
Store an area.
| area_name | the name of the area |
| area | the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1081 of file Map2DStorage.cpp.
|
overridevirtual |
Store a location specified by the user in the world reference frame.
| location_name | the name of the location |
| loc | the location of the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1075 of file Map2DStorage.cpp.
|
overridevirtual |
Store a object specified by the user in the world reference frame.
| object_name | the name of the location |
| obj | the location of the object |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1415 of file Map2DStorage.cpp.
|
overridevirtual |
Store a path.
| path_name | the name of the path |
| path | the path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1087 of file Map2DStorage.cpp.