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>
Public Member Functions | |
Map2DStorage () | |
Map2DStorage. More... | |
~Map2DStorage () | |
bool | open (yarp::os::Searchable ¶ms) override |
Open the DeviceDriver. More... | |
bool | close () override |
Close the DeviceDriver. More... | |
bool | clearAllMaps () override |
Removes all the registered maps from the server. More... | |
bool | store_map (const yarp::dev::Nav2D::MapGrid2D &map) override |
Stores a map into the map server. More... | |
bool | get_map (std::string map_name, yarp::dev::Nav2D::MapGrid2D &map) override |
Gets a map from the map server. More... | |
bool | get_map_names (std::vector< std::string > &map_names) override |
Gets a list containing the names of all registered maps. More... | |
bool | remove_map (std::string map_name) override |
Removes a map from the map server. More... | |
bool | storeLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation loc) override |
Store a location specified by the user in the world reference frame. More... | |
bool | storeArea (std::string area_name, yarp::dev::Nav2D::Map2DArea area) override |
Store an area. More... | |
bool | storePath (std::string path_name, yarp::dev::Nav2D::Map2DPath path) override |
Store a path. More... | |
bool | getLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation &loc) override |
Retrieves a location specified by the user in the world reference frame. More... | |
bool | getArea (std::string area_name, yarp::dev::Nav2D::Map2DArea &area) override |
Retrieves an area. More... | |
bool | getPath (std::string path_name, yarp::dev::Nav2D::Map2DPath &path) override |
Retrieves a path. More... | |
bool | getLocationsList (std::vector< std::string > &locations) override |
Get a list of the names of all stored locations. More... | |
bool | getAreasList (std::vector< std::string > &areas) override |
Get a list of the names of all stored areas. More... | |
bool | getPathsList (std::vector< std::string > &paths) override |
Get a list of the names of all stored paths. More... | |
bool | getAllLocations (std::vector< yarp::dev::Nav2D::Map2DLocation > &locations) override |
Get a list of all stored locations. More... | |
bool | getAllAreas (std::vector< yarp::dev::Nav2D::Map2DArea > &areas) override |
Get a list of all stored areas. More... | |
bool | getAllPaths (std::vector< yarp::dev::Nav2D::Map2DPath > &paths) override |
Get a list of all stored paths. More... | |
bool | renameLocation (std::string original_name, std::string new_name) override |
Searches for a location and renames it. More... | |
bool | deleteLocation (std::string location_name) override |
Delete a location. More... | |
bool | deletePath (std::string path_name) override |
Delete a path. More... | |
bool | renameArea (std::string original_name, std::string new_name) override |
Searches for an area and renames it. More... | |
bool | renamePath (std::string original_name, std::string new_name) override |
Searches for a path and renames it. More... | |
bool | deleteArea (std::string area_name) override |
Delete an area. More... | |
bool | clearAllLocations () override |
Delete all stored locations. More... | |
bool | clearAllAreas () override |
Delete all stored areas. More... | |
bool | clearAllPaths () override |
Delete all stored paths. More... | |
bool | clearAllMapsTemporaryFlags () override |
Clear all temporary flags from all stored maps. More... | |
bool | clearMapTemporaryFlags (std::string map_name) override |
Clear all temporary flags from a specific map. More... | |
bool | saveMapToDisk (std::string map_name, std::string file_name) override |
Save a map to disk. More... | |
bool | loadMapFromDisk (std::string file_name) override |
Load a map from disk. More... | |
bool | saveMapsCollection (std::string maps_collection_file) override |
Save a collection of maps to disk. More... | |
bool | loadMapsCollection (std::string maps_collection_file) override |
Load a collection of maps from disk. More... | |
bool | loadLocationsAndExtras (std::string locations_file) override |
Load a collection of locations/areas/paths etc from disk. More... | |
bool | saveLocationsAndExtras (std::string locations_file) override |
Save a collection of locations/area/paths etc to disk. More... | |
bool | enableMapsCompression (bool enable) override |
99999999999 More... | |
![]() | |
DeviceDriver () | |
DeviceDriver (const DeviceDriver &other)=delete | |
DeviceDriver (DeviceDriver &&other) noexcept=delete | |
DeviceDriver & | operator= (const DeviceDriver &other)=delete |
DeviceDriver & | operator= (DeviceDriver &&other) noexcept=delete |
~DeviceDriver () override | |
bool | open (yarp::os::Searchable &config) override |
Open the DeviceDriver. More... | |
bool | close () override |
Close the DeviceDriver. More... | |
virtual std::string | id () const |
Return the id assigned to the PolyDriver. More... | |
virtual void | setId (const std::string &id) |
Set the id for this device. More... | |
template<class T > | |
bool | view (T *&x) |
Get an interface to the device driver. More... | |
virtual DeviceDriver * | getImplementation () |
Some drivers are bureaucrats, pointing at others. More... | |
![]() | |
virtual | ~IConfig () |
Destructor. More... | |
virtual bool | open (Searchable &config) |
Initialize the object. More... | |
virtual bool | close () |
Shut the object down. More... | |
virtual bool | configure (Searchable &config) |
Change online parameters. More... | |
![]() | |
virtual | ~PortReader () |
Destructor. More... | |
virtual bool | read (ConnectionReader &reader)=0 |
Read this object from a network connection. More... | |
virtual Type | getReadType () const |
![]() | |
virtual | ~IMap2D () |
Destructor. More... | |
virtual bool | clearAllMaps ()=0 |
Removes all the registered maps from the server. More... | |
virtual bool | store_map (const yarp::dev::Nav2D::MapGrid2D &map)=0 |
Stores a map into the map server. More... | |
virtual bool | get_map (std::string map_name, yarp::dev::Nav2D::MapGrid2D &map)=0 |
Gets a map from the map server. More... | |
virtual bool | get_map_names (std::vector< std::string > &map_names)=0 |
Gets a list containing the names of all registered maps. More... | |
virtual bool | remove_map (std::string map_name)=0 |
Removes a map from the map server. More... | |
virtual bool | storeLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation loc)=0 |
Store a location specified by the user in the world reference frame. More... | |
virtual bool | storeArea (std::string area_name, yarp::dev::Nav2D::Map2DArea area)=0 |
Store an area. More... | |
virtual bool | storePath (std::string path_name, yarp::dev::Nav2D::Map2DPath path)=0 |
Store a path. More... | |
virtual bool | getLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation &loc)=0 |
Retrieves a location specified by the user in the world reference frame. More... | |
virtual bool | getArea (std::string area_name, yarp::dev::Nav2D::Map2DArea &area)=0 |
Retrieves an area. More... | |
virtual bool | getPath (std::string path_name, yarp::dev::Nav2D::Map2DPath &path)=0 |
Retrieves a path. More... | |
virtual bool | getLocationsList (std::vector< std::string > &locations)=0 |
Get a list of the names of all stored locations. More... | |
virtual bool | getAreasList (std::vector< std::string > &areas)=0 |
Get a list of the names of all stored areas. More... | |
virtual bool | getPathsList (std::vector< std::string > &paths)=0 |
Get a list of the names of all stored paths. More... | |
virtual bool | getAllLocations (std::vector< yarp::dev::Nav2D::Map2DLocation > &locations)=0 |
Get a list of all stored locations. More... | |
virtual bool | getAllAreas (std::vector< yarp::dev::Nav2D::Map2DArea > &areas)=0 |
Get a list of all stored areas. More... | |
virtual bool | getAllPaths (std::vector< yarp::dev::Nav2D::Map2DPath > &paths)=0 |
Get a list of all stored paths. More... | |
virtual bool | renameLocation (std::string original_name, std::string new_name)=0 |
Searches for a location and renames it. More... | |
virtual bool | deleteLocation (std::string location_name)=0 |
Delete a location. More... | |
virtual bool | deletePath (std::string path_name)=0 |
Delete a path. More... | |
virtual bool | renameArea (std::string original_name, std::string new_name)=0 |
Searches for an area and renames it. More... | |
virtual bool | renamePath (std::string original_name, std::string new_name)=0 |
Searches for a path and renames it. More... | |
virtual bool | deleteArea (std::string area_name)=0 |
Delete an area. More... | |
virtual bool | clearAllLocations ()=0 |
Delete all stored locations. More... | |
virtual bool | clearAllAreas ()=0 |
Delete all stored areas. More... | |
virtual bool | clearAllPaths ()=0 |
Delete all stored paths. More... | |
virtual bool | clearAllMapsTemporaryFlags ()=0 |
Clear all temporary flags from all stored maps. More... | |
virtual bool | clearMapTemporaryFlags (std::string map_name)=0 |
Clear all temporary flags from a specific map. More... | |
virtual bool | saveMapToDisk (std::string map_name, std::string file_name)=0 |
Save a map to disk. More... | |
virtual bool | loadMapFromDisk (std::string file_name)=0 |
Load a map from disk. More... | |
virtual bool | saveMapsCollection (std::string file_name)=0 |
Save a collection of maps to disk. More... | |
virtual bool | loadMapsCollection (std::string file_name)=0 |
Load a collection of maps from disk. More... | |
virtual bool | saveLocationsAndExtras (std::string file_name)=0 |
Save a collection of locations/area/paths etc to disk. More... | |
virtual bool | loadLocationsAndExtras (std::string file_name)=0 |
Load a collection of locations/areas/paths etc from disk. More... | |
virtual bool | enableMapsCompression (bool enable)=0 |
99999999999 More... | |
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:
Parameter name | SubParameter | Type | Units | Default Value | Required | Description | Notes |
---|---|---|---|---|---|---|---|
name | - | string | - | /mapServer/rpc | No | Full name of the rpc port opened by the Map2DServer device. | |
mapCollection | - | string | - | - | No | The name of .ini file containing a map collection. |
Definition at line 55 of file map2DStorage.h.
Map2DStorage::Map2DStorage | ( | ) |
Definition at line 33 of file map2DStorage.cpp.
|
default |
|
overridevirtual |
Delete all stored areas.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 984 of file map2DStorage.cpp.
|
overridevirtual |
Delete all stored locations.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 978 of file map2DStorage.cpp.
|
overridevirtual |
Removes all the registered maps from the server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 717 of file map2DStorage.cpp.
|
overridevirtual |
Clear all temporary flags from all stored maps.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 996 of file map2DStorage.cpp.
|
overridevirtual |
Delete all stored paths.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 990 of file map2DStorage.cpp.
|
overridevirtual |
Clear all temporary flags from a specific map.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1005 of file map2DStorage.cpp.
|
overridevirtual |
Close the DeviceDriver.
Reimplemented from yarp::dev::DeviceDriver.
Definition at line 242 of file map2DStorage.cpp.
|
overridevirtual |
Delete an area.
area_name | the name of the area |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 914 of file map2DStorage.cpp.
|
overridevirtual |
Delete a location.
location_name | the name of the location |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 902 of file map2DStorage.cpp.
|
overridevirtual |
Delete a path.
path_name | the name of the path |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 926 of file map2DStorage.cpp.
|
overridevirtual |
99999999999
enable |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 1107 of file map2DStorage.cpp.
|
overridevirtual |
Gets a map from the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 740 of file map2DStorage.cpp.
|
overridevirtual |
Gets a list containing the names of all registered maps.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 751 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 865 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 855 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 874 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 803 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 835 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 792 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 825 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 814 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 845 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 579 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 1079 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 75 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. See device invocation examples. 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 139 of file map2DStorage.cpp.
|
overridevirtual |
Removes a map from the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 761 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 938 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 884 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 957 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 645 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 39 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 1054 of file map2DStorage.cpp.
|
overridevirtual |
Stores a map into the map server.
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 723 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 780 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 robot |
Implements yarp::dev::Nav2D::IMap2D.
Definition at line 774 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 786 of file map2DStorage.cpp.