Map2D_nws_ros Class Reference

map2D_nws_ros: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros/src/devices/map2D_nws_ros/Map2D_nws_ros.h>

Inheritance diagram for Map2D_nws_ros:

Public Member Functions
	Map2D_nws_ros ()
	Map2D_nws_ros.
	~Map2D_nws_ros ()
bool	open (yarp::os::Searchable &params) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
bool	detach () override
	Detach the object (you must have first called attach).
bool	attach (yarp::dev::PolyDriver *driver) override
	Attach to another object.
Public Member Functions inherited from yarp::dev::DeviceDriver
	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
virtual std::string	id () const
	Return the id assigned to the PolyDriver.
virtual void	setId (const std::string &id)
	Set the id for this device.
template<class T >
bool	view (T *&x)
	Get an interface to the device driver.
virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.
Public Member Functions inherited from yarp::os::IConfig
virtual	~IConfig ()
	Destructor.
virtual bool	configure (Searchable &config)
	Change online parameters.
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::dev::WrapperSingle
	~WrapperSingle () override
	Destructor.
bool	attachAll (const yarp::dev::PolyDriverList &drivers) final
	Attach to a list of objects.
bool	detachAll () final
	Detach the object (you must have first called attach).
Public Member Functions inherited from yarp::dev::IWrapper
virtual	~IWrapper ()
	Destructor.
Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual	~IMultipleWrapper ()
	Destructor.

Detailed Description

map2D_nws_ros: A device capable of read/save collections of maps from disk, and make them accessible to any Map2DClient device.

Map2D_nws_ros

Parameters required by this device are:

Parameter name	SubParameter	Type	Units	Default Value	Required	Description	Notes
name	-	string	-	/map2D_nws_ros/rpc	No	Full name of the rpc port opened by the Map2DServer device.
ROS	enable_publisher	bool	-	false	No	Publishes maps stored in a map2DStorage on a ROS topic
ROS	enable_subscriber	bool	-	false	No	Receives maps from a ROS topic and stores them in a map2DStorage

Definition at line 61 of file Map2D_nws_ros.h.

Constructor & Destructor Documentation

Map2D_nws_ros()

Map2D_nws_ros::Map2D_nws_ros

(

)

Map2D_nws_ros.

Definition at line 50 of file Map2D_nws_ros.cpp.

~Map2D_nws_ros()

Map2D_nws_ros::~Map2D_nws_ros ( )

default

Member Function Documentation

attach()

bool Map2D_nws_ros::attach ( yarp::dev::PolyDriver *  driver )

overridevirtual

Attach to another object.

Parameters

driver

the polydriver that you want to attach to.

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 386 of file Map2D_nws_ros.cpp.

close()

bool Map2D_nws_ros::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 285 of file Map2D_nws_ros.cpp.

detach()

bool Map2D_nws_ros::detach ( )

overridevirtual

Detach the object (you must have first called attach).

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 380 of file Map2D_nws_ros.cpp.

open()

bool Map2D_nws_ros::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 90 of file Map2D_nws_ros.cpp.

---

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

• opt-modules/yarp-devices-ros/src/devices/map2D_nws_ros/Map2D_nws_ros.h
• opt-modules/yarp-devices-ros/src/devices/map2D_nws_ros/Map2D_nws_ros.cpp