map2DClient: A device which allows a client application to store/retrieve user maps device in a map server. More...

#include <map2DClient/Map2DClient.h>

Inheritance diagram for Map2DClient:

Public Member Functions
bool	open (yarp::os::Searchable &config) 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	remove_map (std::string map_name) override
	Removes a map from the map 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	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 location_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 location_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	renameLocation (std::string original_name, std::string new_name) override
	Searches for a location and renames it. 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	deleteLocation (std::string location_name) override
	Delete a location. More...

bool	deleteArea (std::string location_name) override
	Delete an area. More...

bool	deletePath (std::string path_name) override
	Delete 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 > &locations) 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	clearAllLocations () override
	Delete all stored locations. More...

bool	clearAllAreas () override
	Delete all stored areas. More...

bool	clearAllPaths () override
	Delete all stored paths. 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::dev::Nav2D::IMap2D
virtual	~IMap2D ()
	Destructor. More...

Protected Attributes
yarp::os::Port	m_rpcPort_to_Map2DServer

std::string	m_local_name

std::string	m_map_server

Detailed Description

map2DClient: A device which allows a client application to store/retrieve user maps device in a map server.

Map2DClient

Parameters required by this device are:

Parameter name	SubParameter	Type	Units	Default Value	Required	Description	Notes
local	-	string	-	-	Yes	Full port name opened by the Map2DClient device.
remote	-	string	-	-	Yes	Full port name of the port remotely opened by the Map2DServer, to which the Map2DClient connects to.

Definition at line 50 of file Map2DClient.h.

Member Function Documentation

◆ clearAllAreas()

bool Map2DClient::clearAllAreas ( )

overridevirtual

Delete all stored areas.

Returns: true/false

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

Definition at line 773 of file Map2DClient.cpp.

◆ clearAllLocations()

bool Map2DClient::clearAllLocations ( )

overridevirtual

Delete all stored locations.

Returns: true/false

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

Definition at line 747 of file Map2DClient.cpp.

◆ clearAllMaps()

bool Map2DClient::clearAllMaps ( )

overridevirtual

Removes all the registered maps from the server.

Returns: true/false

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

Definition at line 153 of file Map2DClient.cpp.

◆ clearAllPaths()

bool Map2DClient::clearAllPaths ( )

overridevirtual

Delete all stored paths.

Returns: true/false

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

Definition at line 799 of file Map2DClient.cpp.

◆ close()

bool Map2DClient::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 825 of file Map2DClient.cpp.

◆ deleteArea()

bool Map2DClient::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 637 of file Map2DClient.cpp.

◆ deleteLocation()

bool Map2DClient::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 582 of file Map2DClient.cpp.

◆ deletePath()

bool Map2DClient::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 664 of file Map2DClient.cpp.

◆ get_map()

bool Map2DClient::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 114 of file Map2DClient.cpp.

◆ get_map_names()

bool Map2DClient::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 178 of file Map2DClient.cpp.

◆ getArea()

bool Map2DClient::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 502 of file Map2DClient.cpp.

◆ getAreasList()

bool Map2DClient::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 380 of file Map2DClient.cpp.

◆ getLocation()

bool Map2DClient::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 468 of file Map2DClient.cpp.

◆ getLocationsList()

bool Map2DClient::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 336 of file Map2DClient.cpp.

◆ getPath()

bool Map2DClient::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 542 of file Map2DClient.cpp.

◆ getPathsList()

bool Map2DClient::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 424 of file Map2DClient.cpp.

◆ open()

bool Map2DClient::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 40 of file Map2DClient.cpp.

◆ remove_map()

bool Map2DClient::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 211 of file Map2DClient.cpp.

◆ renameArea()

bool Map2DClient::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 691 of file Map2DClient.cpp.

◆ renameLocation()

bool Map2DClient::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 609 of file Map2DClient.cpp.

◆ renamePath()

bool Map2DClient::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 719 of file Map2DClient.cpp.

◆ store_map()

bool Map2DClient::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 82 of file Map2DClient.cpp.

◆ storeArea()

bool Map2DClient::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 268 of file Map2DClient.cpp.

◆ storeLocation()

bool Map2DClient::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 237 of file Map2DClient.cpp.

◆ storePath()

bool Map2DClient::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 302 of file Map2DClient.cpp.

Member Data Documentation

◆ m_local_name

std::string Map2DClient::m_local_name

protected

Definition at line 56 of file Map2DClient.h.

◆ m_map_server

std::string Map2DClient::m_map_server

protected

Definition at line 57 of file Map2DClient.h.

◆ m_rpcPort_to_Map2DServer

yarp::os::Port Map2DClient::m_rpcPort_to_Map2DServer

protected

Definition at line 55 of file Map2DClient.h.

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

src/devices/map2DClient/Map2DClient.h
src/devices/map2DClient/Map2DClient.cpp

Public Member Functions

Protected Attributes

Detailed Description

Map2DClient

Member Function Documentation

◆ clearAllAreas()

◆ clearAllLocations()

◆ clearAllMaps()

◆ clearAllPaths()

◆ close()

◆ deleteArea()

◆ deleteLocation()

◆ deletePath()

◆ get_map()

◆ get_map_names()

◆ getArea()

◆ getAreasList()

◆ getLocation()

◆ getLocationsList()

◆ getPath()

◆ getPathsList()

◆ open()

◆ remove_map()

◆ renameArea()

◆ renameLocation()

◆ renamePath()

◆ store_map()

◆ storeArea()

◆ storeLocation()

◆ storePath()

Member Data Documentation

◆ m_local_name

◆ m_map_server

◆ m_rpcPort_to_Map2DServer