YARP
Yet Another Robot Platform
Public Member Functions | List of all members
Map2D_nws_yarp Class Reference
Devices » Device Implementations » YARP Network Wrapper Servers (NWS) | Devices » Device Implementations » Navigation Devices

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

#include <map2D_nws_yarp/Map2D_nws_yarp.h>

+ Inheritance diagram for Map2D_nws_yarp:

Public Member Functions

 Map2D_nws_yarp ()
 Map2D_nws_yarp. More...
 
 ~Map2D_nws_yarp ()
 
bool open (yarp::os::Searchable &params) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
bool detach () override
 Detach the object (you must have first called attach). More...
 
bool attach (yarp::dev::PolyDriver *driver) override
 Attach to another object. More...
 
- 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
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
virtual std::string id () const
 Return the id assigned to the PolyDriver. More...
 
virtual void setId (const std::string &id)
 Set the id for this device. 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 open (Searchable &config)
 Initialize the object. More...
 
virtual bool close ()
 Shut the object down. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::dev::WrapperSingle
 ~WrapperSingle () override
 Destructor. More...
 
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects. More...
 
bool detachAll () final
 Detach the object (you must have first called attach). More...
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor. More...
 
virtual bool attach (PolyDriver *driver)=0
 Attach to another object. More...
 
virtual bool detach ()=0
 Detach the object (you must have first called attach). More...
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor. More...
 
virtual bool attachAll (const PolyDriverList &drivers)=0
 Attach to a list of objects. More...
 
virtual bool detachAll ()=0
 Detach the object (you must have first called attach). More...
 

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:

Parameter name SubParameter Type Units Default Value Required Description Notes
name - string - /map2D_nws_yarp/rpc No Full name of the rpc port opened by the map2D_nws_yarp device.

Definition at line 53 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
driverthe polydriver that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 115 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 103 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 109 of file Map2D_nws_yarp.cpp.

◆ open()

bool Map2D_nws_yarp::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis 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: