#include <yarp/dev/IMap2D.h>

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

Public Member Functions
virtual	~IMap2D ()
	Destructor.

virtual yarp::dev::ReturnValue	clearAllMaps ()=0
	Removes all the registered maps from the server.

virtual yarp::dev::ReturnValue	store_map (const yarp::dev::Nav2D::MapGrid2D &map)=0
	Stores a map into the map server.

virtual yarp::dev::ReturnValue	get_map (std::string map_name, yarp::dev::Nav2D::MapGrid2D &map)=0
	Gets a map from the map server.

virtual yarp::dev::ReturnValue	get_map_names (std::vector< std::string > &map_names)=0
	Gets a list containing the names of all registered maps.

virtual yarp::dev::ReturnValue	remove_map (std::string map_name)=0
	Removes a map from the map server.

virtual yarp::dev::ReturnValue	storeLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation loc)=0
	Store a location specified by the user in the world reference frame.

virtual yarp::dev::ReturnValue	storeArea (std::string area_name, yarp::dev::Nav2D::Map2DArea area)=0
	Store an area.

virtual yarp::dev::ReturnValue	storePath (std::string path_name, yarp::dev::Nav2D::Map2DPath path)=0
	Store a path.

virtual yarp::dev::ReturnValue	getLocation (std::string location_name, yarp::dev::Nav2D::Map2DLocation &loc)=0
	Retrieves a location specified by the user in the world reference frame.

virtual yarp::dev::ReturnValue	getArea (std::string area_name, yarp::dev::Nav2D::Map2DArea &area)=0
	Retrieves an area.

virtual yarp::dev::ReturnValue	getPath (std::string path_name, yarp::dev::Nav2D::Map2DPath &path)=0
	Retrieves a path.

virtual yarp::dev::ReturnValue	getLocationsList (std::vector< std::string > &locations)=0
	Get a list of the names of all stored locations.

virtual yarp::dev::ReturnValue	getAreasList (std::vector< std::string > &areas)=0
	Get a list of the names of all stored areas.

virtual yarp::dev::ReturnValue	getPathsList (std::vector< std::string > &paths)=0
	Get a list of the names of all stored paths.

virtual yarp::dev::ReturnValue	getAllLocations (std::vector< yarp::dev::Nav2D::Map2DLocation > &locations)=0
	Get a list of all stored locations.

virtual yarp::dev::ReturnValue	getAllAreas (std::vector< yarp::dev::Nav2D::Map2DArea > &areas)=0
	Get a list of all stored areas.

virtual yarp::dev::ReturnValue	getAllPaths (std::vector< yarp::dev::Nav2D::Map2DPath > &paths)=0
	Get a list of all stored paths.

virtual yarp::dev::ReturnValue	renameLocation (std::string original_name, std::string new_name)=0
	Searches for a location and renames it.

virtual yarp::dev::ReturnValue	deleteLocation (std::string location_name)=0
	Delete a location.

virtual yarp::dev::ReturnValue	deletePath (std::string path_name)=0
	Delete a path.

virtual yarp::dev::ReturnValue	renameArea (std::string original_name, std::string new_name)=0
	Searches for an area and renames it.

virtual yarp::dev::ReturnValue	renamePath (std::string original_name, std::string new_name)=0
	Searches for a path and renames it.

virtual yarp::dev::ReturnValue	deleteArea (std::string area_name)=0
	Delete an area.

virtual yarp::dev::ReturnValue	clearAllLocations ()=0
	Delete all stored locations.

virtual yarp::dev::ReturnValue	clearAllAreas ()=0
	Delete all stored areas.

virtual yarp::dev::ReturnValue	clearAllPaths ()=0
	Delete all stored paths.

virtual yarp::dev::ReturnValue	clearAllMapsTemporaryFlags ()=0
	Clear all temporary flags from all stored maps.

virtual yarp::dev::ReturnValue	clearMapTemporaryFlags (std::string map_name)=0
	Clear all temporary flags from a specific map.

virtual yarp::dev::ReturnValue	saveMapToDisk (std::string map_name, std::string file_name)=0
	Save a map to disk.

virtual yarp::dev::ReturnValue	loadMapFromDisk (std::string file_name)=0
	Load a map from disk.

virtual yarp::dev::ReturnValue	saveMapsCollection (std::string file_name)=0
	Save a collection of maps to disk.

virtual yarp::dev::ReturnValue	loadMapsCollection (std::string file_name)=0
	Load a collection of maps from disk.

virtual yarp::dev::ReturnValue	saveLocationsAndExtras (std::string file_name)=0
	Save a collection of locations/area/paths etc to disk.

virtual yarp::dev::ReturnValue	loadLocationsAndExtras (std::string file_name)=0
	Load a collection of locations/areas/paths etc from disk.

virtual yarp::dev::ReturnValue	enableMapsCompression (bool enable)=0
	Enable/disables maps compression over the network.

Detailed Description

IMap2D Interface.

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

Definition at line 29 of file IMap2D.h.

Constructor & Destructor Documentation

◆ ~IMap2D()

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

virtualdefault

Destructor.

Member Function Documentation

◆ clearAllAreas()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::clearAllAreas ( )

pure virtual

Delete all stored areas.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ clearAllLocations()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::clearAllLocations ( )

pure virtual

Delete all stored locations.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ clearAllMaps()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::clearAllMaps ( )

pure virtual

Removes all the registered maps from the server.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ clearAllMapsTemporaryFlags()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::clearAllMapsTemporaryFlags ( )

pure virtual

Clear all temporary flags from all stored maps.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ clearAllPaths()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::clearAllPaths ( )

pure virtual

Delete all stored paths.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ clearMapTemporaryFlags()

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

pure virtual

Clear all temporary flags from a specific map.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ deleteArea()

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

pure virtual

Delete an area.

Parameters

area_name the name of the area

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ deleteLocation()

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

pure virtual

Delete a location.

Parameters

location_name the name of the location

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ deletePath()

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

pure virtual

Delete a path.

Parameters

path_name the name of the path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ enableMapsCompression()

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

pure virtual

Enable/disables maps compression over the network.

Parameters

enable

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ get_map()

virtual yarp::dev::ReturnValue 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: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ get_map_names()

virtual yarp::dev::ReturnValue 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: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getAllAreas()

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

pure virtual

Get a list of all stored areas.

Parameters

the	returned list of areas

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getAllLocations()

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

pure virtual

Get a list of all stored locations.

Parameters

the	returned list of locations

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getAllPaths()

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

pure virtual

Get a list of all stored paths.

Parameters

the	returned list of paths

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getArea()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::getArea	(	std::string	area_name,
		yarp::dev::Nav2D::Map2DArea &	area
	)

pure virtual

Retrieves an area.

Parameters

area_name	the name of the area
area	the area

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getAreasList()

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

pure virtual

Get a list of the names of all stored areas.

Parameters

the	returned list of areas names

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getLocation()

virtual yarp::dev::ReturnValue 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_name	the name of the location
loc	the location

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getLocationsList()

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

pure virtual

Get a list of the names of all stored locations.

Parameters

the	returned list of locations names

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getPath()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::getPath	(	std::string	path_name,
		yarp::dev::Nav2D::Map2DPath &	path
	)

pure virtual

Retrieves a path.

Parameters

path_name	the name of the path
path	the path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ getPathsList()

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

pure virtual

Get a list of the names of all stored paths.

Parameters

the	returned list of paths names

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ loadLocationsAndExtras()

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

pure virtual

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

Parameters

file_name file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2D_nwc_yarp, Navigation2D_nwc_yarp, and Map2DStorage.

◆ loadMapFromDisk()

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

pure virtual

Load a map from disk.

Parameters

file_name file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ loadMapsCollection()

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

pure virtual

Load a collection of maps from disk.

Parameters

file_name file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ remove_map()

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

pure virtual

Removes a map from the map server.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ renameArea()

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

pure virtual

Searches for an area and renames it.

Parameters

original_name	the name of the area
new_name	the new name of the area

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ renameLocation()

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

pure virtual

Searches for a location and renames it.

Parameters

original_name	the name of the area
new_name	the new name of the area

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ renamePath()

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

pure virtual

Searches for a path and renames it.

Parameters

original_name	the name of the path
new_name	the new name of the path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ saveLocationsAndExtras()

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

pure virtual

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

Parameters

file_name file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2D_nwc_yarp, Navigation2D_nwc_yarp, and Map2DStorage.

◆ saveMapsCollection()

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

pure virtual

Save a collection of maps to disk.

Parameters

file_name file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ saveMapToDisk()

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

pure virtual

Save a map to disk.

Parameters

map_name	the name of the area
file_name	file name with full path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ store_map()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IMap2D::store_map ( const yarp::dev::Nav2D::MapGrid2D & map )

pure virtual

Stores a map into the map server.

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ storeArea()

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

pure virtual

Store an area.

Parameters

area_name	the name of the area
area	the area

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ storeLocation()

virtual yarp::dev::ReturnValue 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_name	the name of the location
loc	the location of the robot

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

◆ storePath()

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

pure virtual

Store a path.

Parameters

path_name	the name of the path
path	the path

Returns: a ReturnValue, convertible to true/false

Implemented in Map2DStorage, Map2D_nwc_yarp, and Navigation2D_nwc_yarp.

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

src/libYARP_dev/src/yarp/dev/IMap2D.h
src/libYARP_dev/src/yarp/dev/IMap2D.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMap2D()

Member Function Documentation

◆ clearAllAreas()

◆ clearAllLocations()

◆ clearAllMaps()

◆ clearAllMapsTemporaryFlags()

◆ clearAllPaths()

◆ clearMapTemporaryFlags()

◆ deleteArea()

◆ deleteLocation()

◆ deletePath()

◆ enableMapsCompression()

◆ get_map()

◆ get_map_names()

◆ getAllAreas()

◆ getAllLocations()

◆ getAllPaths()

◆ getArea()

◆ getAreasList()

◆ getLocation()

◆ getLocationsList()

◆ getPath()

◆ getPathsList()

◆ loadLocationsAndExtras()

◆ loadMapFromDisk()

◆ loadMapsCollection()

◆ remove_map()

◆ renameArea()

◆ renameLocation()

◆ renamePath()

◆ saveLocationsAndExtras()

◆ saveMapsCollection()

◆ saveMapToDisk()

◆ store_map()

◆ storeArea()

◆ storeLocation()

◆ storePath()