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

#include <networkWrappers/mobileBaseVelocityControl_nws_yarp/MobileBaseVelocityControl_nws_yarp_ParamsParser.h>

Inheritance diagram for MobileBaseVelocityControl_nws_yarp_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	MobileBaseVelocityControl_nws_yarp_ParamsParser ()

	~MobileBaseVelocityControl_nws_yarp_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 = {"MobileBaseVelocityControl_nws_yarp"}

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

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

const std::string	m_local_defaultValue = {"/MobileBaseVelocityControl_nws"}

std::string	m_local = {"/MobileBaseVelocityControl_nws"}

Detailed Description

This class is the parameters parser for class MobileBaseVelocityControl_nws_yarp.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	local	string	-	/MobileBaseVelocityControl_nws	1	Name of the port opened by the device. For both ports (i.e. /rpc:i, /data:i) the corresponding suffix is automatically added	-

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

yarpdev --device mobileBaseVelocityControl_nws_yarp --local /MobileBaseVelocityControl_nws

Definition at line 41 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

Constructor & Destructor Documentation

◆ MobileBaseVelocityControl_nws_yarp_ParamsParser()

MobileBaseVelocityControl_nws_yarp_ParamsParser::MobileBaseVelocityControl_nws_yarp_ParamsParser ( )

Definition at line 23 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

◆ ~MobileBaseVelocityControl_nws_yarp_ParamsParser()

MobileBaseVelocityControl_nws_yarp_ParamsParser::~MobileBaseVelocityControl_nws_yarp_ParamsParser ( )

overridedefault

Member Function Documentation

◆ getConfiguration()

std::string MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

◆ getDeviceClassName()

std::string MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ getDeviceName()

std::string MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

◆ getParamValue()

bool MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

◆ parseParams()

bool MobileBaseVelocityControl_nws_yarp_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 MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string MobileBaseVelocityControl_nws_yarp_ParamsParser::m_device_classname = {"MobileBaseVelocityControl_nws_yarp"}

Definition at line 48 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_device_name

const std::string MobileBaseVelocityControl_nws_yarp_ParamsParser::m_device_name = {"mobileBaseVelocityControl_nws_yarp"}

Definition at line 49 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_local

std::string MobileBaseVelocityControl_nws_yarp_ParamsParser::m_local = {"/MobileBaseVelocityControl_nws"}

Definition at line 62 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_local_defaultValue

const std::string MobileBaseVelocityControl_nws_yarp_ParamsParser::m_local_defaultValue = {"/MobileBaseVelocityControl_nws"}

Definition at line 60 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_parser_is_strict

bool MobileBaseVelocityControl_nws_yarp_ParamsParser::m_parser_is_strict = false

Definition at line 50 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_parser_version

const parser_version_type MobileBaseVelocityControl_nws_yarp_ParamsParser::m_parser_version = {}

Definition at line 56 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

◆ m_provided_configuration

std::string MobileBaseVelocityControl_nws_yarp_ParamsParser::m_provided_configuration

Definition at line 58 of file MobileBaseVelocityControl_nws_yarp_ParamsParser.h.

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

src/devices/networkWrappers/mobileBaseVelocityControl_nws_yarp/MobileBaseVelocityControl_nws_yarp_ParamsParser.h
src/devices/networkWrappers/mobileBaseVelocityControl_nws_yarp/MobileBaseVelocityControl_nws_yarp_ParamsParser.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MobileBaseVelocityControl_nws_yarp_ParamsParser()

◆ ~MobileBaseVelocityControl_nws_yarp_ParamsParser()

Member Function Documentation

◆ getConfiguration()

◆ getDeviceClassName()

◆ getDeviceName()

◆ getDocumentationOfDeviceParams()

◆ getListOfParams()

◆ getParamValue()

◆ parseParams()

Member Data Documentation

◆ m_device_classname

◆ m_device_name

◆ m_local

◆ m_local_defaultValue

◆ m_parser_is_strict

◆ m_parser_version

◆ m_provided_configuration