DeviceBundler_ParamsParser Class Reference

This class is the parameters parser for class DeviceBundler. More...

#include <deviceBundler/DeviceBundler_ParamsParser.h>

Inheritance diagram for DeviceBundler_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	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 ()

Public Attributes
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

This class is the parameters parser for class DeviceBundler.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	wrapper_device	string	-	device_name1	1	Name of the wrapper device	This device must derive from yarp::dev::IWrapper
-	attached_device	string	-	device_name2	1	Name of the subdevice that will be attached to the wrapper device	-
-	doNotAttach	bool	-	false	0	If set to true, the two devices are opened, but not attached	It should not be used, except for debugging purposes

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device deviceBundler --wrapper_device device_name1 --attached_device device_name2 --doNotAttach false

yarpdev --device deviceBundler --wrapper_device device_name1 --attached_device device_name2

Definition at line 43 of file DeviceBundler_ParamsParser.h.

Constructor & Destructor Documentation

DeviceBundler_ParamsParser()

DeviceBundler_ParamsParser::DeviceBundler_ParamsParser

(

)

Definition at line 23 of file DeviceBundler_ParamsParser.cpp.

~DeviceBundler_ParamsParser()

DeviceBundler_ParamsParser::~DeviceBundler_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string DeviceBundler_ParamsParser::getDeviceClassName ( ) const

inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns

A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 69 of file DeviceBundler_ParamsParser.h.

getDeviceName()

std::string DeviceBundler_ParamsParser::getDeviceName ( ) const

inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns

A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 70 of file DeviceBundler_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string DeviceBundler_ParamsParser::getDocumentationOfDeviceParams ( ) const

overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns

A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 123 of file DeviceBundler_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > DeviceBundler_ParamsParser::getListOfParams ( ) const

overridevirtual

Return a list of all params used by the device.

Returns

A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file DeviceBundler_ParamsParser.cpp.

parseParams()

bool DeviceBundler_ParamsParser::parseParams ( const yarp::os::Searchable &  config )

overridevirtual

Parse the DeviceDriver parameters.

Returns

true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 38 of file DeviceBundler_ParamsParser.cpp.

Member Data Documentation

m_attached_device

std::string DeviceBundler_ParamsParser::m_attached_device = {"device_name2"}

Definition at line 65 of file DeviceBundler_ParamsParser.h.

m_attached_device_defaultValue

const std::string DeviceBundler_ParamsParser::m_attached_device_defaultValue = {"device_name2"}

Definition at line 61 of file DeviceBundler_ParamsParser.h.

m_device_classname

const std::string DeviceBundler_ParamsParser::m_device_classname = {"DeviceBundler"}

Definition at line 50 of file DeviceBundler_ParamsParser.h.

m_device_name

const std::string DeviceBundler_ParamsParser::m_device_name = {"deviceBundler"}

Definition at line 51 of file DeviceBundler_ParamsParser.h.

m_doNotAttach

bool DeviceBundler_ParamsParser::m_doNotAttach = {false}

Definition at line 66 of file DeviceBundler_ParamsParser.h.

m_doNotAttach_defaultValue

const std::string DeviceBundler_ParamsParser::m_doNotAttach_defaultValue = {"false"}

Definition at line 62 of file DeviceBundler_ParamsParser.h.

m_parser_is_strict

bool DeviceBundler_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file DeviceBundler_ParamsParser.h.

m_parser_version

const parser_version_type DeviceBundler_ParamsParser::m_parser_version = {}

Definition at line 58 of file DeviceBundler_ParamsParser.h.

m_wrapper_device

std::string DeviceBundler_ParamsParser::m_wrapper_device = {"device_name1"}

Definition at line 64 of file DeviceBundler_ParamsParser.h.

m_wrapper_device_defaultValue

const std::string DeviceBundler_ParamsParser::m_wrapper_device_defaultValue = {"device_name1"}

Definition at line 60 of file DeviceBundler_ParamsParser.h.

---

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

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