FakeRawValuesPublisher_ParamsParser Class Reference

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

#include <FakeRawValuesPublisher_ParamsParser.h>

Inheritance diagram for FakeRawValuesPublisher_ParamsParser:

Classes
struct	parser_version_type

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

Public Attributes
const std::string	m_device_classname = {"FakeRawValuesPublisher"}
const std::string	m_device_name = {"fakeRawValuesPublisher"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_name_defaultValue = {""}
const std::string	m_njomos_defaultValue = {""}
const std::string	m_threshold_defaultValue = {""}
std::string	m_name = {}
int	m_njomos = {0}
int	m_threshold = {0}

Detailed Description

This class is the parameters parser for class FakeRawValuesPublisher.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	name	string	-	-	1	Name of the device	-
-	njomos	int	-	-	1	Number of joint or motors to be instantiated	-
-	threshold	int	-	-	1	Threshold used for defining the amplitude of the sawthooth curve that simulates periodic raw encoder data	-

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

yarpdev --device fakeRawValuesPublisher --name <mandatory_value> --njomos <mandatory_value> --threshold <mandatory_value>

yarpdev --device fakeRawValuesPublisher --name <mandatory_value> --njomos <mandatory_value> --threshold <mandatory_value>

Definition at line 44 of file FakeRawValuesPublisher_ParamsParser.h.

Constructor & Destructor Documentation

FakeRawValuesPublisher_ParamsParser()

FakeRawValuesPublisher_ParamsParser::FakeRawValuesPublisher_ParamsParser

(

)

Definition at line 23 of file FakeRawValuesPublisher_ParamsParser.cpp.

~FakeRawValuesPublisher_ParamsParser()

FakeRawValuesPublisher_ParamsParser::~FakeRawValuesPublisher_ParamsParser ( )

default

Member Function Documentation

getDeviceClassName()

std::string FakeRawValuesPublisher_ParamsParser::getDeviceClassName ( ) const

inline

Definition at line 70 of file FakeRawValuesPublisher_ParamsParser.h.

getDeviceName()

std::string FakeRawValuesPublisher_ParamsParser::getDeviceName ( ) const

inline

Definition at line 71 of file FakeRawValuesPublisher_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeRawValuesPublisher_ParamsParser::getDocumentationOfDeviceParams

(

)

const

Definition at line 125 of file FakeRawValuesPublisher_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeRawValuesPublisher_ParamsParser::getListOfParams

(

)

const

Definition at line 28 of file FakeRawValuesPublisher_ParamsParser.cpp.

parseParams()

bool FakeRawValuesPublisher_ParamsParser::parseParams

(

const yarp::os::Searchable &

config

)

Definition at line 38 of file FakeRawValuesPublisher_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FakeRawValuesPublisher_ParamsParser::m_device_classname = {"FakeRawValuesPublisher"}

Definition at line 51 of file FakeRawValuesPublisher_ParamsParser.h.

m_device_name

const std::string FakeRawValuesPublisher_ParamsParser::m_device_name = {"fakeRawValuesPublisher"}

Definition at line 52 of file FakeRawValuesPublisher_ParamsParser.h.

m_name

std::string FakeRawValuesPublisher_ParamsParser::m_name = {}

Definition at line 65 of file FakeRawValuesPublisher_ParamsParser.h.

m_name_defaultValue

const std::string FakeRawValuesPublisher_ParamsParser::m_name_defaultValue = {""}

Definition at line 61 of file FakeRawValuesPublisher_ParamsParser.h.

m_njomos

int FakeRawValuesPublisher_ParamsParser::m_njomos = {0}

Definition at line 66 of file FakeRawValuesPublisher_ParamsParser.h.

m_njomos_defaultValue

const std::string FakeRawValuesPublisher_ParamsParser::m_njomos_defaultValue = {""}

Definition at line 62 of file FakeRawValuesPublisher_ParamsParser.h.

m_parser_is_strict

bool FakeRawValuesPublisher_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file FakeRawValuesPublisher_ParamsParser.h.

m_parser_version

const parser_version_type FakeRawValuesPublisher_ParamsParser::m_parser_version = {}

Definition at line 59 of file FakeRawValuesPublisher_ParamsParser.h.

m_threshold

int FakeRawValuesPublisher_ParamsParser::m_threshold = {0}

Definition at line 67 of file FakeRawValuesPublisher_ParamsParser.h.

m_threshold_defaultValue

const std::string FakeRawValuesPublisher_ParamsParser::m_threshold_defaultValue = {""}

Definition at line 63 of file FakeRawValuesPublisher_ParamsParser.h.

---

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

• icub-main/src/libraries/icubmod/fakeRawValuesPublisher/FakeRawValuesPublisher_ParamsParser.h
• icub-main/src/libraries/icubmod/fakeRawValuesPublisher/FakeRawValuesPublisher_ParamsParser.cpp