Map2D_nws_yarp Class Reference

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

#include <networkWrappers/map2D_nws_yarp/Map2D_nws_yarp.h>

Inheritance diagram for Map2D_nws_yarp:

Public Member Functions
	Map2D_nws_yarp ()
	Map2D_nws_yarp.
	~Map2D_nws_yarp ()
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
virtual	~DeviceDriver ()
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::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.
Public Member Functions inherited from Map2D_nws_yarp_ParamsParser
	Map2D_nws_yarp_ParamsParser ()
	~Map2D_nws_yarp_ParamsParser () override=default
bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.
std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.
std::string	getDeviceName () const override
	Get the name of the device (i.e.
std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.
std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.
Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Additional Inherited Members
Public Attributes inherited from Map2D_nws_yarp_ParamsParser
const std::string	m_device_classname = {"Map2D_nws_yarp"}
const std::string	m_device_name = {"map2D_nws_yarp"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_name_defaultValue = {"/map2D_nws_yarp/rpc"}
std::string	m_name = {"/map2D_nws_yarp/rpc"}

Detailed Description

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

Map2D_nws_yarp

Parameters required by this device are shown in class: Map2D_nws_yarp_ParamsParser

Definition at line 51 of file Map2D_nws_yarp.h.

Constructor & Destructor Documentation

Map2D_nws_yarp()

Map2D_nws_yarp::Map2D_nws_yarp

(

)

Map2D_nws_yarp.

Definition at line 37 of file Map2D_nws_yarp.cpp.

~Map2D_nws_yarp()

Map2D_nws_yarp::~Map2D_nws_yarp ( )

default

Member Function Documentation

attach()

bool Map2D_nws_yarp::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 87 of file Map2D_nws_yarp.cpp.

close()

bool Map2D_nws_yarp::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 71 of file Map2D_nws_yarp.cpp.

detach()

bool Map2D_nws_yarp::detach ( )

overridevirtual

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

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 81 of file Map2D_nws_yarp.cpp.

open()

bool Map2D_nws_yarp::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 54 of file Map2D_nws_yarp.cpp.

---

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

• src/devices/networkWrappers/map2D_nws_yarp/Map2D_nws_yarp.h
• src/devices/networkWrappers/map2D_nws_yarp/Map2D_nws_yarp.cpp