ControlBoardCouplingHandler_ParamsParser Class Reference

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

#include <controlBoardCouplingHandler/ControlBoardCouplingHandler_ParamsParser.h>

Inheritance diagram for ControlBoardCouplingHandler_ParamsParser:

Classes
struct	parser_version_type

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

Public Attributes
const std::string	m_device_classname = {"ControlBoardCouplingHandler"}
const std::string	m_device_name = {"controlBoardCouplingHandler"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_coupling_device_defaultValue = {""}
std::string	m_coupling_device = {}

Detailed Description

This class is the parameters parser for class ControlBoardCouplingHandler.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	coupling_device	string	-	-	1	Name of the device that handles the coupling	-

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

yarpdev --device controlBoardCouplingHandler --coupling_device <mandatory_value>

yarpdev --device controlBoardCouplingHandler --coupling_device <mandatory_value>

Definition at line 41 of file ControlBoardCouplingHandler_ParamsParser.h.

Constructor & Destructor Documentation

ControlBoardCouplingHandler_ParamsParser()

ControlBoardCouplingHandler_ParamsParser::ControlBoardCouplingHandler_ParamsParser

(

)

Definition at line 23 of file ControlBoardCouplingHandler_ParamsParser.cpp.

~ControlBoardCouplingHandler_ParamsParser()

ControlBoardCouplingHandler_ParamsParser::~ControlBoardCouplingHandler_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string ControlBoardCouplingHandler_ParamsParser::getConfiguration ( ) const

overridevirtual

Return the configuration of the device.

Returns

The configuration of the device, represented in a string format.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 50 of file ControlBoardCouplingHandler_ParamsParser.cpp.

getDeviceClassName()

std::string ControlBoardCouplingHandler_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 65 of file ControlBoardCouplingHandler_ParamsParser.h.

getDeviceName()

std::string ControlBoardCouplingHandler_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 66 of file ControlBoardCouplingHandler_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string ControlBoardCouplingHandler_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 115 of file ControlBoardCouplingHandler_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > ControlBoardCouplingHandler_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 ControlBoardCouplingHandler_ParamsParser.cpp.

getParamValue()

bool ControlBoardCouplingHandler_ParamsParser::getParamValue ( const std::string &  paramName, std::string &  paramValue  ) const

overridevirtual

Return the value (represented as a string) of the requested parameter.

Returns

True if the requested parameter was succesfully retrieved.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 36 of file ControlBoardCouplingHandler_ParamsParser.cpp.

parseParams()

bool ControlBoardCouplingHandler_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 60 of file ControlBoardCouplingHandler_ParamsParser.cpp.

Member Data Documentation

m_coupling_device

std::string ControlBoardCouplingHandler_ParamsParser::m_coupling_device = {}

Definition at line 62 of file ControlBoardCouplingHandler_ParamsParser.h.

m_coupling_device_defaultValue

const std::string ControlBoardCouplingHandler_ParamsParser::m_coupling_device_defaultValue = {""}

Definition at line 60 of file ControlBoardCouplingHandler_ParamsParser.h.

m_device_classname

const std::string ControlBoardCouplingHandler_ParamsParser::m_device_classname = {"ControlBoardCouplingHandler"}

Definition at line 48 of file ControlBoardCouplingHandler_ParamsParser.h.

m_device_name

const std::string ControlBoardCouplingHandler_ParamsParser::m_device_name = {"controlBoardCouplingHandler"}

Definition at line 49 of file ControlBoardCouplingHandler_ParamsParser.h.

m_parser_is_strict

bool ControlBoardCouplingHandler_ParamsParser::m_parser_is_strict = false

Definition at line 50 of file ControlBoardCouplingHandler_ParamsParser.h.

m_parser_version

const parser_version_type ControlBoardCouplingHandler_ParamsParser::m_parser_version = {}

Definition at line 56 of file ControlBoardCouplingHandler_ParamsParser.h.

m_provided_configuration

std::string ControlBoardCouplingHandler_ParamsParser::m_provided_configuration

Definition at line 58 of file ControlBoardCouplingHandler_ParamsParser.h.

---

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

• src/devices/controlBoardCouplingHandler/ControlBoardCouplingHandler_ParamsParser.h
• src/devices/controlBoardCouplingHandler/ControlBoardCouplingHandler_ParamsParser.cpp