CouplingICubEye_ParamsParser Class Reference

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

#include <CouplingICubEye_ParamsParser.h>

Inheritance diagram for CouplingICubEye_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	CouplingICubEye_ParamsParser ()
	~CouplingICubEye_ParamsParser () override=default
bool	parseParams (const yarp::os::Searchable &config) override
std::string	getDeviceClassName () const override
std::string	getDeviceName () const override
std::string	getDocumentationOfDeviceParams () const override
std::vector< std::string >	getListOfParams () const override

Public Attributes
const std::string	m_device_classname = {"CouplingICubEye"}
const std::string	m_device_name = {"couplingICubEye"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_jointNames_defaultValue = {""}
const std::string	m_LIMITS_jntPosMin_defaultValue = {""}
const std::string	m_LIMITS_jntPosMax_defaultValue = {""}
const std::string	m_COUPLING_device_defaultValue = {""}
const std::string	m_COUPLING_actuatedAxesNames_defaultValue = {""}
const std::string	m_COUPLING_actuatedAxesPosMin_defaultValue = {""}
const std::string	m_COUPLING_actuatedAxesPosMax_defaultValue = {""}
std::vector< std::string >	m_jointNames = {}
std::vector< double >	m_LIMITS_jntPosMin = {}
std::vector< double >	m_LIMITS_jntPosMax = {}
std::string	m_COUPLING_device = {}
std::vector< std::string >	m_COUPLING_actuatedAxesNames = {}
std::vector< double >	m_COUPLING_actuatedAxesPosMin = {}
std::vector< double >	m_COUPLING_actuatedAxesPosMax = {}

Detailed Description

This class is the parameters parser for class CouplingICubEye.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	jointNames	vector<string>	-	-	1	Names of the physical joints	-
LIMITS	jntPosMin	vector<double>	-	-	1	Physical joints' position minimum	-
LIMITS	jntPosMax	vector<double>	-	-	1	Physical joints' position maximum	-
COUPLING	device	string	-	-	1	Name of the device that handles the coupling	-
COUPLING	actuatedAxesNames	vector<string>	-	-	1	Names of the actuated axes	-
COUPLING	actuatedAxesPosMin	vector<double>	-	-	1	Actuated axes' position minimum	-
COUPLING	actuatedAxesPosMax	vector<double>	-	-	1	Actuated axes' position maximum	-

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

yarpdev --device couplingICubEye --jointNames <mandatory_value> --LIMITS::jntPosMin <mandatory_value> --LIMITS::jntPosMax <mandatory_value> --COUPLING::device <mandatory_value> --COUPLING::actuatedAxesNames <mandatory_value> --COUPLING::actuatedAxesPosMin <mandatory_value> --COUPLING::actuatedAxesPosMax <mandatory_value>

yarpdev --device couplingICubEye --jointNames <mandatory_value> --LIMITS::jntPosMin <mandatory_value> --LIMITS::jntPosMax <mandatory_value> --COUPLING::device <mandatory_value> --COUPLING::actuatedAxesNames <mandatory_value> --COUPLING::actuatedAxesPosMin <mandatory_value> --COUPLING::actuatedAxesPosMax <mandatory_value>

Definition at line 47 of file CouplingICubEye_ParamsParser.h.

Constructor & Destructor Documentation

CouplingICubEye_ParamsParser()

CouplingICubEye_ParamsParser::CouplingICubEye_ParamsParser

(

)

Definition at line 23 of file CouplingICubEye_ParamsParser.cpp.

~CouplingICubEye_ParamsParser()

CouplingICubEye_ParamsParser::~CouplingICubEye_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string CouplingICubEye_ParamsParser::getDeviceClassName ( ) const

inlineoverride

Definition at line 81 of file CouplingICubEye_ParamsParser.h.

getDeviceName()

std::string CouplingICubEye_ParamsParser::getDeviceName ( ) const

inlineoverride

Definition at line 82 of file CouplingICubEye_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string CouplingICubEye_ParamsParser::getDocumentationOfDeviceParams ( ) const

override

Definition at line 295 of file CouplingICubEye_ParamsParser.cpp.

getListOfParams()

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

override

Definition at line 28 of file CouplingICubEye_ParamsParser.cpp.

parseParams()

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

override

Definition at line 42 of file CouplingICubEye_ParamsParser.cpp.

Member Data Documentation

m_COUPLING_actuatedAxesNames

std::vector<std::string> CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesNames = {}

Definition at line 76 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_actuatedAxesNames_defaultValue

const std::string CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesNames_defaultValue = {""}

Definition at line 68 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_actuatedAxesPosMax

std::vector<double> CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesPosMax = {}

Definition at line 78 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_actuatedAxesPosMax_defaultValue

const std::string CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesPosMax_defaultValue = {""}

Definition at line 70 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_actuatedAxesPosMin

std::vector<double> CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesPosMin = {}

Definition at line 77 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_actuatedAxesPosMin_defaultValue

const std::string CouplingICubEye_ParamsParser::m_COUPLING_actuatedAxesPosMin_defaultValue = {""}

Definition at line 69 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_device

std::string CouplingICubEye_ParamsParser::m_COUPLING_device = {}

Definition at line 75 of file CouplingICubEye_ParamsParser.h.

m_COUPLING_device_defaultValue

const std::string CouplingICubEye_ParamsParser::m_COUPLING_device_defaultValue = {""}

Definition at line 67 of file CouplingICubEye_ParamsParser.h.

m_device_classname

const std::string CouplingICubEye_ParamsParser::m_device_classname = {"CouplingICubEye"}

Definition at line 54 of file CouplingICubEye_ParamsParser.h.

m_device_name

const std::string CouplingICubEye_ParamsParser::m_device_name = {"couplingICubEye"}

Definition at line 55 of file CouplingICubEye_ParamsParser.h.

m_jointNames

std::vector<std::string> CouplingICubEye_ParamsParser::m_jointNames = {}

Definition at line 72 of file CouplingICubEye_ParamsParser.h.

m_jointNames_defaultValue

const std::string CouplingICubEye_ParamsParser::m_jointNames_defaultValue = {""}

Definition at line 64 of file CouplingICubEye_ParamsParser.h.

m_LIMITS_jntPosMax

std::vector<double> CouplingICubEye_ParamsParser::m_LIMITS_jntPosMax = {}

Definition at line 74 of file CouplingICubEye_ParamsParser.h.

m_LIMITS_jntPosMax_defaultValue

const std::string CouplingICubEye_ParamsParser::m_LIMITS_jntPosMax_defaultValue = {""}

Definition at line 66 of file CouplingICubEye_ParamsParser.h.

m_LIMITS_jntPosMin

std::vector<double> CouplingICubEye_ParamsParser::m_LIMITS_jntPosMin = {}

Definition at line 73 of file CouplingICubEye_ParamsParser.h.

m_LIMITS_jntPosMin_defaultValue

const std::string CouplingICubEye_ParamsParser::m_LIMITS_jntPosMin_defaultValue = {""}

Definition at line 65 of file CouplingICubEye_ParamsParser.h.

m_parser_is_strict

bool CouplingICubEye_ParamsParser::m_parser_is_strict = false

Definition at line 56 of file CouplingICubEye_ParamsParser.h.

m_parser_version

const parser_version_type CouplingICubEye_ParamsParser::m_parser_version = {}

Definition at line 62 of file CouplingICubEye_ParamsParser.h.

---

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

• icub-main/src/libraries/icubmod/couplingICubEye/CouplingICubEye_ParamsParser.h
• icub-main/src/libraries/icubmod/couplingICubEye/CouplingICubEye_ParamsParser.cpp