DeviceTemplate_ParamsParser Class Reference

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-template/src/devices/deviceTemplate/DeviceTemplate_ParamsParser.h>

Inheritance diagram for DeviceTemplate_ParamsParser:

Public Member Functions
	~DeviceTemplate_ParamsParser () override=default
bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.
std::string	getDeviceType () const override
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 ()
virtual std::string	getDeviceClassName () const =0
	Get the name of the DeviceDriver class.
virtual std::string	getDeviceName () const =0
	Get the name of the device (i.e.
virtual bool	getParamValue (const std::string &paramName, std::string &paramValue) const =0
	Return the value (represented as a string) of the requested parameter.
virtual std::string	getConfiguration () const =0
	Return the configuration of the device.

Public Attributes
const std::string	m_device_type = {"DeviceTemplate"}
bool	m_parser_is_strict = false
std::string	m_dummy_group_dummy_param1 = {"dummy_default_value"}
double	m_dummy_param2 = {9.81}

Detailed Description

This class is the parameters parser for class DeviceTemplate.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
dummy_group	dummy_param1	string	-	dummy_default_value	1	This is the description of dummy_param1	Here are additional notes
-	dummy_param2	double	m/s^2	9.81	0	This is the description of dummy_param2	The default value is the gravity constant

The device can be launched by yarpdev using one of the following examples:

yarpdev --device DeviceTemplate --dummy_group::dummy_param1 dummy_default_value --dummy_param2 9.81

yarpdev --device DeviceTemplate --dummy_group::dummy_param1 dummy_default_value

Definition at line 42 of file DeviceTemplate_ParamsParser.h.

Constructor & Destructor Documentation

~DeviceTemplate_ParamsParser()

DeviceTemplate_ParamsParser::~DeviceTemplate_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceType()

std::string DeviceTemplate_ParamsParser::getDeviceType ( ) const

inlineoverride

Definition at line 54 of file DeviceTemplate_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string DeviceTemplate_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 98 of file DeviceTemplate_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > DeviceTemplate_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 24 of file DeviceTemplate_ParamsParser.cpp.

parseParams()

bool DeviceTemplate_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 33 of file DeviceTemplate_ParamsParser.cpp.

Member Data Documentation

m_device_type

const std::string DeviceTemplate_ParamsParser::m_device_type = {"DeviceTemplate"}

Definition at line 48 of file DeviceTemplate_ParamsParser.h.

m_dummy_group_dummy_param1

std::string DeviceTemplate_ParamsParser::m_dummy_group_dummy_param1 = {"dummy_default_value"}

Definition at line 50 of file DeviceTemplate_ParamsParser.h.

m_dummy_param2

double DeviceTemplate_ParamsParser::m_dummy_param2 = {9.81}

Definition at line 51 of file DeviceTemplate_ParamsParser.h.

m_parser_is_strict

bool DeviceTemplate_ParamsParser::m_parser_is_strict = false

Definition at line 49 of file DeviceTemplate_ParamsParser.h.

---

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

• opt-modules/yarp-device-template/src/devices/deviceTemplate/DeviceTemplate_ParamsParser.h
• opt-modules/yarp-device-template/src/devices/deviceTemplate/DeviceTemplate_ParamsParser.cpp