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

#include <networkWrappers/robotDescription_nws_yarp/RobotDescription_nws_yarp.h>

Inheritance diagram for RobotDescription_nws_yarp:

Public Member Functions
bool	open (yarp::os::Searchable &config) 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.

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::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 RobotDescription_nws_yarp_ParamsParser
	RobotDescription_nws_yarp_ParamsParser ()

	~RobotDescription_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.

bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.

std::string	getConfiguration () const override
	Return the configuration of the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Protected Attributes
std::mutex	m_mutex

yarp::os::Port	m_rpc_port

std::unique_ptr< IRobotDescriptiond >	m_RPC

Additional Inherited Members
Public Attributes inherited from RobotDescription_nws_yarp_ParamsParser
const std::string	m_device_classname = {"RobotDescription_nws_yarp"}

const std::string	m_device_name = {"robotDescription_nws_yarp"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

const std::string	m_local_defaultValue = {"/robotDescriptionServer/rpc"}

std::string	m_local = {"/robotDescriptionServer/rpc"}

Detailed Description

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

Parameters required by this device are shown in class: RobotDescription_nws_yarp_ParamsParser

Definition at line 51 of file RobotDescription_nws_yarp.h.

Member Function Documentation

◆ attach()

bool RobotDescription_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 102 of file RobotDescription_nws_yarp.cpp.

◆ close()

bool RobotDescription_nws_yarp::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 129 of file RobotDescription_nws_yarp.cpp.

◆ detach()

bool RobotDescription_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 122 of file RobotDescription_nws_yarp.cpp.

◆ open()

bool RobotDescription_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 88 of file RobotDescription_nws_yarp.cpp.

◆ read()

bool RobotDescription_nws_yarp::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 135 of file RobotDescription_nws_yarp.cpp.

Member Data Documentation

◆ m_mutex

std::mutex RobotDescription_nws_yarp::m_mutex

protected

Definition at line 58 of file RobotDescription_nws_yarp.h.

◆ m_RPC

std::unique_ptr<IRobotDescriptiond> RobotDescription_nws_yarp::m_RPC

protected

Definition at line 62 of file RobotDescription_nws_yarp.h.

◆ m_rpc_port

yarp::os::Port RobotDescription_nws_yarp::m_rpc_port

protected

Definition at line 59 of file RobotDescription_nws_yarp.h.

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

src/devices/networkWrappers/robotDescription_nws_yarp/RobotDescription_nws_yarp.h
src/devices/networkWrappers/robotDescription_nws_yarp/RobotDescription_nws_yarp.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ attach()

◆ close()

◆ detach()

◆ open()

◆ read()

Member Data Documentation

◆ m_mutex

◆ m_RPC

◆ m_rpc_port