robotDescriptionClient: This client device is used to connect to a robotDescriptionServer and ask info about the currently opened devices. More...

#include <networkWrappers/RobotDescriptionClient/RobotDescriptionClient.h>

Inheritance diagram for RobotDescriptionClient:

Public Member Functions
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

bool	getAllDevices (std::vector< yarp::dev::DeviceDescription > &dev_list) override
	Ask the complete list of all yarp device drivers registered by a robot description server.

bool	getAllDevicesByType (const std::string &type, std::vector< yarp::dev::DeviceDescription > &dev_list) override
	Ask a list of all registered yarp device drivers whose type corresponds to the given param.

bool	registerDevice (const yarp::dev::DeviceDescription &dev) override
	Register a new running yarp device into a robot description server.

bool	unregisterDevice (const std::string &device_name) override
	Unregister a running yarp device from a robot description server.

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::dev::IRobotDescription
virtual	~IRobotDescription ()
	Destructor.

Public Member Functions inherited from RobotDescriptionClient_ParamsParser
	RobotDescriptionClient_ParamsParser ()

	~RobotDescriptionClient_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_mutex

yarp::os::Port	m_rpc_port

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

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

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

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

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

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

Detailed Description

robotDescriptionClient: This client device is used to connect to a robotDescriptionServer and ask info about the currently opened devices.

Parameters required by this device are shown in class: RobotDescriptionClient_ParamsParser

Definition at line 31 of file RobotDescriptionClient.h.

Member Function Documentation

◆ close()

bool RobotDescriptionClient::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 50 of file RobotDescriptionClient.cpp.

◆ getAllDevices()

bool RobotDescriptionClient::getAllDevices ( std::vector< yarp::dev::DeviceDescription > & dev_list )

overridevirtual

Ask the complete list of all yarp device drivers registered by a robot description server.

Implements yarp::dev::IRobotDescription.

Definition at line 149 of file RobotDescriptionClient.cpp.

◆ getAllDevicesByType()

bool RobotDescriptionClient::getAllDevicesByType	(	const std::string &	type,
		std::vector< yarp::dev::DeviceDescription > &	dev_list
	)

overridevirtual

Ask a list of all registered yarp device drivers whose type corresponds to the given param.

Implements yarp::dev::IRobotDescription.

Definition at line 57 of file RobotDescriptionClient.cpp.

◆ open()

bool RobotDescriptionClient::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 26 of file RobotDescriptionClient.cpp.

◆ registerDevice()

bool RobotDescriptionClient::registerDevice ( const yarp::dev::DeviceDescription & dev )

overridevirtual

Register a new running yarp device into a robot description server.

Implements yarp::dev::IRobotDescription.

Definition at line 122 of file RobotDescriptionClient.cpp.

◆ unregisterDevice()

bool RobotDescriptionClient::unregisterDevice ( const std::string & device_name )

overridevirtual

Unregister a running yarp device from a robot description server.

Implements yarp::dev::IRobotDescription.

Definition at line 96 of file RobotDescriptionClient.cpp.

Member Data Documentation

◆ m_mutex

std::mutex RobotDescriptionClient::m_mutex

protected

Definition at line 37 of file RobotDescriptionClient.h.

◆ m_rpc_port

yarp::os::Port RobotDescriptionClient::m_rpc_port

protected

Definition at line 38 of file RobotDescriptionClient.h.

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

src/devices/networkWrappers/RobotDescriptionClient/RobotDescriptionClient.h
src/devices/networkWrappers/RobotDescriptionClient/RobotDescriptionClient.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ close()

◆ getAllDevices()

◆ getAllDevicesByType()

◆ open()

◆ registerDevice()

◆ unregisterDevice()

Member Data Documentation

◆ m_mutex

◆ m_rpc_port