DeviceBundler Class Reference

DeviceBundler: A device capable of opening two additional devices, specified by the user, and perform an attach operation. More...

#include <deviceBundler/DeviceBundler.h>

Inheritance diagram for DeviceBundler:

Public Member Functions
	DeviceBundler ()
	DeviceBundler (const DeviceBundler &)=delete
	DeviceBundler (DeviceBundler &&)=delete
DeviceBundler &	operator= (const DeviceBundler &)=delete
DeviceBundler &	operator= (DeviceBundler &&)=delete
	~DeviceBundler () override
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
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 DeviceBundler_ParamsParser
	DeviceBundler_ParamsParser ()
	~DeviceBundler_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 ()

Additional Inherited Members
Public Attributes inherited from DeviceBundler_ParamsParser
const std::string	m_device_classname = {"DeviceBundler"}
const std::string	m_device_name = {"deviceBundler"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_wrapper_device_defaultValue = {"device_name1"}
const std::string	m_attached_device_defaultValue = {"device_name2"}
const std::string	m_doNotAttach_defaultValue = {"false"}
std::string	m_wrapper_device = {"device_name1"}
std::string	m_attached_device = {"device_name2"}
bool	m_doNotAttach = {false}

Detailed Description

DeviceBundler: A device capable of opening two additional devices, specified by the user, and perform an attach operation.

This device is typically used by yarpdev executable to open a wrapper and subdevice using a single command line. For more complex operations, such as opening and attaching more than two devices, it is recommended to use yarprobotinterface instead.

Parameters required by this device are shown in class: DeviceBundler_ParamsParser

Definition at line 27 of file DeviceBundler.h.

Constructor & Destructor Documentation

DeviceBundler() [1/3]

DeviceBundler::DeviceBundler

(

)

Definition at line 16 of file DeviceBundler.cpp.

DeviceBundler() [2/3]

DeviceBundler::DeviceBundler ( const DeviceBundler &  )

delete

DeviceBundler() [3/3]

DeviceBundler::DeviceBundler ( DeviceBundler &&  )

delete

~DeviceBundler()

DeviceBundler::~DeviceBundler ( )

override

Definition at line 20 of file DeviceBundler.cpp.

Member Function Documentation

close()

bool DeviceBundler::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 90 of file DeviceBundler.cpp.

open()

bool DeviceBundler::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 24 of file DeviceBundler.cpp.

operator=() [1/2]

DeviceBundler & DeviceBundler::operator= ( const DeviceBundler &  )

delete

operator=() [2/2]

DeviceBundler & DeviceBundler::operator= ( DeviceBundler &&  )

delete

---

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

• src/devices/deviceBundler/DeviceBundler.h
• src/devices/deviceBundler/DeviceBundler.cpp