YARP
Yet Another Robot Platform
yarp::dev::RobotDescriptionServer Class Reference

This device is a storage which contains a list of the currently opened device drivers. More...

#include <RobotDescriptionServer/RobotDescriptionServer.h>

+ Inheritance diagram for yarp::dev::RobotDescriptionServer:

Detailed Description

This device is a storage which contains a list of the currently opened device drivers.

yarprobotinterfaces adds/removes devices to the storage using attachAll()/detachAll() methods. A robotDescriptionClient devices can bused by the user to retrieve information about the currently opened devices.

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
local - string - - Yes prefix of the port opened by the device, like /descriptionServer MUST start with a '/' character. /rpc is automatically appended.

Definition at line 44 of file RobotDescriptionServer.h.

Public Member Functions

bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
bool detachAll () override
 Detach the object (you must have first called attach). More...
 
bool attachAll (const yarp::dev::PolyDriverList &l) override
 Attach to a list of objects. More...
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
virtual ~DeviceDriver ()
 Destructor. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 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::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor. More...
 

Member Function Documentation

◆ attachAll()

bool yarp::dev::RobotDescriptionServer::attachAll ( const yarp::dev::PolyDriverList p)
overridevirtual

Attach to a list of objects.

Parameters
pthe polydriver list that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 48 of file RobotDescriptionServer.cpp.

◆ close()

bool yarp::dev::RobotDescriptionServer::close ( void  )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 75 of file RobotDescriptionServer.cpp.

◆ detachAll()

bool yarp::dev::RobotDescriptionServer::detachAll ( )
overridevirtual

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

Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 68 of file RobotDescriptionServer.cpp.

◆ open()

bool yarp::dev::RobotDescriptionServer::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 24 of file RobotDescriptionServer.cpp.

◆ read()

bool yarp::dev::RobotDescriptionServer::read ( yarp::os::ConnectionReader reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 110 of file RobotDescriptionServer.cpp.


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