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

	~Map2DStorage ()

bool	open (yarp::os::Searchable &params) 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 all stored locations. More...

bool	getAreasList (std::vector< std::string > &areas) override
	Get a list of all stored areas. More...

bool	getPathsList (std::vector< std::string > &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	saveMapsCollection (std::string maps_collection_file) override
	Save a collection of maps. More...

bool	loadMapsCollection (std::string maps_collection_file) override
	Load a collection of maps. More...

bool	loadLocationsAndExtras (std::string locations_file) override
	Load a collection of locations/areas/paths etc. More...

bool	saveLocationsAndExtras (std::string locations_file) override
	Save a collection of locations/area/paths etc. More...

Public Member Functions inherited from yarp::dev::DeviceDriver
	~DeviceDriver () override=default
	Destructor. 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...

Public Member Functions inherited from yarp::os::IConfig
virtual	~IConfig ()
	Destructor. More...

virtual bool	configure (Searchable &config)
	Change online parameters. More...

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor. More...

virtual Type	getReadType () const

Public Member Functions inherited from yarp::dev::Nav2D::IMap2D
virtual	~IMap2D ()
	Destructor. More...

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:

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.

Constructor & Destructor Documentation

◆ Map2DStorage()

Map2DStorage::Map2DStorage ( )

Map2DStorage.

Definition at line 33 of file map2DStorage.cpp.

◆ ~Map2DStorage()

Map2DStorage::~Map2DStorage ( )

default

Member Function Documentation

◆ clearAllAreas()

bool Map2DStorage::clearAllAreas ( )

overridevirtual

Delete all stored areas.

Returns: true/false

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

Definition at line 810 of file map2DStorage.cpp.

◆ clearAllLocations()

bool Map2DStorage::clearAllLocations ( )

overridevirtual

Delete all stored locations.

Returns: true/false

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

Definition at line 804 of file map2DStorage.cpp.

◆ clearAllMaps()

bool Map2DStorage::clearAllMaps ( )

overridevirtual

Removes all the registered maps from the server.

Returns: true/false

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

Definition at line 572 of file map2DStorage.cpp.

◆ clearAllMapsTemporaryFlags()

bool Map2DStorage::clearAllMapsTemporaryFlags ( )

overridevirtual

Clear all temporary flags from all stored maps.

Returns: true/false

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

Definition at line 822 of file map2DStorage.cpp.

◆ clearAllPaths()

bool Map2DStorage::clearAllPaths ( )

overridevirtual

Delete all stored paths.

Returns: true/false

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

Definition at line 816 of file map2DStorage.cpp.

◆ clearMapTemporaryFlags()

bool Map2DStorage::clearMapTemporaryFlags ( std::string map_name )

overridevirtual

Clear all temporary flags from a specific map.

Returns: true/false

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

Definition at line 831 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 242 of file map2DStorage.cpp.

◆ deleteArea()

bool Map2DStorage::deleteArea ( std::string area_name )

overridevirtual

Delete an area.

Parameters

area_name the name of the area

Returns: true/false

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

Definition at line 740 of file map2DStorage.cpp.

◆ deleteLocation()

bool Map2DStorage::deleteLocation ( std::string location_name )

overridevirtual

Delete a location.

Parameters

location_name the name of the location

Returns: true/false

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

Definition at line 728 of file map2DStorage.cpp.

◆ deletePath()

bool Map2DStorage::deletePath ( std::string path_name )

overridevirtual

Delete a path.

Parameters

path_name the name of the path

Returns: true/false

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

Definition at line 752 of file map2DStorage.cpp.

◆ get_map()

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

overridevirtual

Gets a map from the map server.

Returns: true/false

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

Definition at line 595 of file map2DStorage.cpp.

◆ get_map_names()

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

overridevirtual

Gets a list containing the names of all registered maps.

Returns: true/false

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

Definition at line 606 of file map2DStorage.cpp.

◆ getArea()

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

overridevirtual

Retrieves an area.

Parameters

area_name	the name of the area
area	the area

Returns: true/false

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

Definition at line 658 of file map2DStorage.cpp.

◆ getAreasList()

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

overridevirtual

Get a list of all stored areas.

Parameters

the	returned list of areas

Returns: true/false

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

Definition at line 690 of file map2DStorage.cpp.

◆ getLocation()

bool 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_name	the name of the location
loc	the location

Returns: true/false

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

Definition at line 647 of file map2DStorage.cpp.

◆ getLocationsList()

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

overridevirtual

Get a list of all stored locations.

Parameters

the	returned list of locations

Returns: true/false

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

Definition at line 680 of file map2DStorage.cpp.

◆ getPath()

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

overridevirtual

Retrieves a path.

Parameters

path_name	the name of the path
path	the path

Returns: true/false

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

Definition at line 669 of file map2DStorage.cpp.

◆ getPathsList()

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

overridevirtual

Get a list of all stored paths.

Parameters

the	returned list of paths

Returns: true/false

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

Definition at line 700 of file map2DStorage.cpp.

◆ loadLocationsAndExtras()

bool Map2DStorage::loadLocationsAndExtras ( std::string locations_collection_file )

overridevirtual

Load a collection of locations/areas/paths etc.

Returns: true/false

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

Definition at line 449 of file map2DStorage.cpp.

◆ loadMapsCollection()

bool Map2DStorage::loadMapsCollection ( std::string maps_collection_file )

overridevirtual

Load a collection of maps.

Returns: true/false

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

Definition at line 75 of file map2DStorage.cpp.

◆ open()

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

overridevirtual

Open the DeviceDriver.

Parameters

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

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 139 of file map2DStorage.cpp.

◆ remove_map()

bool Map2DStorage::remove_map ( std::string map_name )

overridevirtual

Removes a map from the map server.

Returns: true/false

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

Definition at line 616 of file map2DStorage.cpp.

◆ renameArea()

bool Map2DStorage::renameArea	(	std::string	original_name,
		std::string	new_name
	)

overridevirtual

Searches for an area and renames it.

Parameters

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

Returns: true/false

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

Definition at line 764 of file map2DStorage.cpp.

◆ renameLocation()

bool Map2DStorage::renameLocation	(	std::string	original_name,
		std::string	new_name
	)

overridevirtual

Searches for a location and renames it.

Parameters

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

Returns: true/false

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

Definition at line 710 of file map2DStorage.cpp.

◆ renamePath()

bool Map2DStorage::renamePath	(	std::string	original_name,
		std::string	new_name
	)

overridevirtual

Searches for a path and renames it.

Parameters

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

Returns: true/false

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

Definition at line 783 of file map2DStorage.cpp.

◆ saveLocationsAndExtras()

bool Map2DStorage::saveLocationsAndExtras ( std::string locations_collection_file )

overridevirtual

Save a collection of locations/area/paths etc.

Returns: true/false

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

Definition at line 506 of file map2DStorage.cpp.

◆ saveMapsCollection()

bool Map2DStorage::saveMapsCollection ( std::string maps_collection_file )

overridevirtual

Save a collection of maps.

Returns: true/false

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

Definition at line 39 of file map2DStorage.cpp.

◆ store_map()

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

overridevirtual

Stores a map into the map server.

Returns: true/false

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

Definition at line 578 of file map2DStorage.cpp.

◆ storeArea()

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

overridevirtual

Store an area.

Parameters

area_name	the name of the area
area	the area

Returns: true/false

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

Definition at line 635 of file map2DStorage.cpp.

◆ storeLocation()

bool 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_name	the name of the location
loc	the location of the robot

Returns: true/false

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

Definition at line 629 of file map2DStorage.cpp.

◆ storePath()

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

overridevirtual

Store a path.

Parameters

path_name	the name of the path
path	the path

Returns: true/false

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

Definition at line 641 of file map2DStorage.cpp.

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

src/devices/map2DStorage/map2DStorage.h
src/devices/map2DStorage/map2DStorage.cpp

Public Member Functions

Detailed Description

Map2DStorage

Constructor & Destructor Documentation

◆ Map2DStorage()

◆ ~Map2DStorage()

Member Function Documentation

◆ clearAllAreas()

◆ clearAllLocations()

◆ clearAllMaps()

◆ clearAllMapsTemporaryFlags()

◆ clearAllPaths()

◆ clearMapTemporaryFlags()

◆ close()

◆ deleteArea()

◆ deleteLocation()

◆ deletePath()

◆ get_map()

◆ get_map_names()

◆ getArea()

◆ getAreasList()

◆ getLocation()

◆ getLocationsList()

◆ getPath()

◆ getPathsList()

◆ loadLocationsAndExtras()

◆ loadMapsCollection()

◆ open()

◆ remove_map()

◆ renameArea()

◆ renameLocation()

◆ renamePath()

◆ saveLocationsAndExtras()

◆ saveMapsCollection()

◆ store_map()

◆ storeArea()

◆ storeLocation()

◆ storePath()