RobotDescriptionServer Class Reference

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

#include <networkWrappers/RobotDescriptionServer/RobotDescriptionServer.h>

Inheritance diagram for RobotDescriptionServer:

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

Protected Attributes
std::mutex	m_external_mutex
std::mutex	m_internal_mutex
yarp::os::Port	m_rpc_port
std::vector< yarp::dev::DeviceDescription >	m_robot_devices

Additional Inherited Members
Public Attributes inherited from RobotDescriptionServer_ParamsParser
const std::string	m_device_classname = {"RobotDescriptionServer"}
const std::string	m_device_name = {"robotDescriptionServer"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_local_defaultValue = {"/robotDescriptionServer/rpc"}
std::string	m_local = {"/robotDescriptionServer/rpc"}

Detailed Description

robotDescriptionServer: 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 used by the user to retrieve information about the currently opened devices.

Parameters required by this device are shown in class: RobotDescriptionServer_ParamsParser

Definition at line 34 of file RobotDescriptionServer.h.

Member Function Documentation

attachAll()

bool RobotDescriptionServer::attachAll ( const yarp::dev::PolyDriverList &  drivers )

overridevirtual

Attach to a list of objects.

Parameters

drivers

the polydriver list that you want to attach to.

Returns

true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 39 of file RobotDescriptionServer.cpp.

close()

bool RobotDescriptionServer::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 66 of file RobotDescriptionServer.cpp.

detachAll()

bool 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 59 of file RobotDescriptionServer.cpp.

open()

bool RobotDescriptionServer::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 25 of file RobotDescriptionServer.cpp.

read()

bool RobotDescriptionServer::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 101 of file RobotDescriptionServer.cpp.

Member Data Documentation

m_external_mutex

std::mutex RobotDescriptionServer::m_external_mutex

protected

Definition at line 41 of file RobotDescriptionServer.h.

m_internal_mutex

std::mutex RobotDescriptionServer::m_internal_mutex

protected

Definition at line 42 of file RobotDescriptionServer.h.

m_robot_devices

std::vector<yarp::dev::DeviceDescription> RobotDescriptionServer::m_robot_devices

protected

Definition at line 44 of file RobotDescriptionServer.h.

m_rpc_port

yarp::os::Port RobotDescriptionServer::m_rpc_port

protected

Definition at line 43 of file RobotDescriptionServer.h.

---

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

• src/devices/networkWrappers/RobotDescriptionServer/RobotDescriptionServer.h
• src/devices/networkWrappers/RobotDescriptionServer/RobotDescriptionServer.cpp