YARP
Yet Another Robot Platform
yarp::dev::Nav2D::IMap2D Class Referenceabstract

IMap2D Interface. More...

#include <yarp/dev/IMap2D.h>

+ Inheritance diagram for yarp::dev::Nav2D::IMap2D:

Public Member Functions

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...
 

Detailed Description

IMap2D Interface.

Provides methods to store/retrieve map grids and locations to/from a map server.

Definition at line 28 of file IMap2D.h.

Constructor & Destructor Documentation

◆ ~IMap2D()

yarp::dev::Nav2D::IMap2D::~IMap2D ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clearAllAreas()

virtual bool yarp::dev::Nav2D::IMap2D::clearAllAreas ( )
pure virtual

Delete all stored areas.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ clearAllLocations()

virtual bool yarp::dev::Nav2D::IMap2D::clearAllLocations ( )
pure virtual

Delete all stored locations.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ clearAllMaps()

virtual bool yarp::dev::Nav2D::IMap2D::clearAllMaps ( )
pure virtual

Removes all the registered maps from the server.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ clearAllMapsTemporaryFlags()

virtual bool yarp::dev::Nav2D::IMap2D::clearAllMapsTemporaryFlags ( )
pure virtual

Clear all temporary flags from all stored maps.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ clearAllPaths()

virtual bool yarp::dev::Nav2D::IMap2D::clearAllPaths ( )
pure virtual

Delete all stored paths.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ clearMapTemporaryFlags()

virtual bool yarp::dev::Nav2D::IMap2D::clearMapTemporaryFlags ( std::string  map_name)
pure virtual

Clear all temporary flags from a specific map.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ deleteArea()

virtual bool yarp::dev::Nav2D::IMap2D::deleteArea ( std::string  area_name)
pure virtual

Delete an area.

Parameters
area_namethe name of the area
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, Map2D_nwc_yarp, and Map2DStorage.

◆ deleteLocation()

virtual bool yarp::dev::Nav2D::IMap2D::deleteLocation ( std::string  location_name)
pure virtual

Delete a location.

Parameters
location_namethe name of the location
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ deletePath()

virtual bool yarp::dev::Nav2D::IMap2D::deletePath ( std::string  path_name)
pure virtual

Delete a path.

Parameters
path_namethe name of the path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ enableMapsCompression()

virtual bool yarp::dev::Nav2D::IMap2D::enableMapsCompression ( bool  enable)
pure virtual

99999999999

Parameters
enable
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ get_map()

virtual bool yarp::dev::Nav2D::IMap2D::get_map ( std::string  map_name,
yarp::dev::Nav2D::MapGrid2D map 
)
pure virtual

Gets a map from the map server.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ get_map_names()

virtual bool yarp::dev::Nav2D::IMap2D::get_map_names ( std::vector< std::string > &  map_names)
pure virtual

Gets a list containing the names of all registered maps.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getAllAreas()

virtual bool yarp::dev::Nav2D::IMap2D::getAllAreas ( std::vector< yarp::dev::Nav2D::Map2DArea > &  areas)
pure virtual

Get a list of all stored areas.

Parameters
thereturned list of areas
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getAllLocations()

virtual bool yarp::dev::Nav2D::IMap2D::getAllLocations ( std::vector< yarp::dev::Nav2D::Map2DLocation > &  locations)
pure virtual

Get a list of all stored locations.

Parameters
thereturned list of locations
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getAllPaths()

virtual bool yarp::dev::Nav2D::IMap2D::getAllPaths ( std::vector< yarp::dev::Nav2D::Map2DPath > &  paths)
pure virtual

Get a list of all stored paths.

Parameters
thereturned list of paths
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getArea()

virtual bool yarp::dev::Nav2D::IMap2D::getArea ( std::string  area_name,
yarp::dev::Nav2D::Map2DArea area 
)
pure virtual

Retrieves an area.

Parameters
area_namethe name of the area
areathe area
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, Map2D_nwc_yarp, and Map2DStorage.

◆ getAreasList()

virtual bool yarp::dev::Nav2D::IMap2D::getAreasList ( std::vector< std::string > &  areas)
pure virtual

Get a list of the names of all stored areas.

Parameters
thereturned list of areas names
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, Map2D_nwc_yarp, and Map2DStorage.

◆ getLocation()

virtual bool yarp::dev::Nav2D::IMap2D::getLocation ( std::string  location_name,
yarp::dev::Nav2D::Map2DLocation loc 
)
pure virtual

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

Parameters
location_namethe name of the location
locthe location
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getLocationsList()

virtual bool yarp::dev::Nav2D::IMap2D::getLocationsList ( std::vector< std::string > &  locations)
pure virtual

Get a list of the names of all stored locations.

Parameters
thereturned list of locations names
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getPath()

virtual bool yarp::dev::Nav2D::IMap2D::getPath ( std::string  path_name,
yarp::dev::Nav2D::Map2DPath path 
)
pure virtual

Retrieves a path.

Parameters
path_namethe name of the path
paththe path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ getPathsList()

virtual bool yarp::dev::Nav2D::IMap2D::getPathsList ( std::vector< std::string > &  paths)
pure virtual

Get a list of the names of all stored paths.

Parameters
thereturned list of paths names
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ loadLocationsAndExtras()

virtual bool yarp::dev::Nav2D::IMap2D::loadLocationsAndExtras ( std::string  file_name)
pure virtual

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

Parameters
file_namefile name with full path
Returns
true/false

Implemented in Map2DStorage, Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, and Map2D_nwc_yarp.

◆ loadMapFromDisk()

virtual bool yarp::dev::Nav2D::IMap2D::loadMapFromDisk ( std::string  file_name)
pure virtual

Load a map from disk.

Parameters
file_namefile name with full path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ loadMapsCollection()

virtual bool yarp::dev::Nav2D::IMap2D::loadMapsCollection ( std::string  file_name)
pure virtual

Load a collection of maps from disk.

Parameters
file_namefile name with full path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ remove_map()

virtual bool yarp::dev::Nav2D::IMap2D::remove_map ( std::string  map_name)
pure virtual

Removes a map from the map server.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ renameArea()

virtual bool yarp::dev::Nav2D::IMap2D::renameArea ( std::string  original_name,
std::string  new_name 
)
pure virtual

Searches for an area and renames it.

Parameters
original_namethe name of the area
new_namethe new name of the area
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ renameLocation()

virtual bool yarp::dev::Nav2D::IMap2D::renameLocation ( std::string  original_name,
std::string  new_name 
)
pure virtual

Searches for a location and renames it.

Parameters
original_namethe name of the area
new_namethe new name of the area
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ renamePath()

virtual bool yarp::dev::Nav2D::IMap2D::renamePath ( std::string  original_name,
std::string  new_name 
)
pure virtual

Searches for a path and renames it.

Parameters
original_namethe name of the path
new_namethe new name of the path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ saveLocationsAndExtras()

virtual bool yarp::dev::Nav2D::IMap2D::saveLocationsAndExtras ( std::string  file_name)
pure virtual

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

Parameters
file_namefile name with full path
Returns
true/false

Implemented in Map2DStorage, Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, and Map2D_nwc_yarp.

◆ saveMapsCollection()

virtual bool yarp::dev::Nav2D::IMap2D::saveMapsCollection ( std::string  file_name)
pure virtual

Save a collection of maps to disk.

Parameters
file_namefile name with full path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ saveMapToDisk()

virtual bool yarp::dev::Nav2D::IMap2D::saveMapToDisk ( std::string  map_name,
std::string  file_name 
)
pure virtual

Save a map to disk.

Parameters
map_namethe name of the area
file_namefile name with full path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ store_map()

virtual bool yarp::dev::Nav2D::IMap2D::store_map ( const yarp::dev::Nav2D::MapGrid2D map)
pure virtual

Stores a map into the map server.

Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ storeArea()

virtual bool yarp::dev::Nav2D::IMap2D::storeArea ( std::string  area_name,
yarp::dev::Nav2D::Map2DArea  area 
)
pure virtual

Store an area.

Parameters
area_namethe name of the area
areathe area
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DClient, Map2DStorage, and Map2D_nwc_yarp.

◆ storeLocation()

virtual bool yarp::dev::Nav2D::IMap2D::storeLocation ( std::string  location_name,
yarp::dev::Nav2D::Map2DLocation  loc 
)
pure virtual

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

Parameters
location_namethe name of the location
locthe location of the robot
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.

◆ storePath()

virtual bool yarp::dev::Nav2D::IMap2D::storePath ( std::string  path_name,
yarp::dev::Nav2D::Map2DPath  path 
)
pure virtual

Store a path.

Parameters
path_namethe name of the path
paththe path
Returns
true/false

Implemented in Navigation2DClient, Navigation2D_nwc_yarp, Map2DStorage, Map2DClient, and Map2D_nwc_yarp.


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