FakeIMU_ParamsParser Class Reference

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

#include <fake/fakeIMU/FakeIMU_ParamsParser.h>

Inheritance diagram for FakeIMU_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeIMU_ParamsParser ()
	~FakeIMU_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.
Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Public Attributes
const std::string	m_device_classname = {"FakeIMU"}
const std::string	m_device_name = {"fakeIMU"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_period_defaultValue = {"10"}
const std::string	m_constantValue_defaultValue = {"false"}
const std::string	m_sensorName_defaultValue = {"sensorName"}
const std::string	m_frameName_defaultValue = {"frameName"}
int	m_period = {10}
bool	m_constantValue = {false}
std::string	m_sensorName = {"sensorName"}
std::string	m_frameName = {"frameName"}

Detailed Description

This class is the parameters parser for class FakeIMU.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	int	millisecond	10	0	Period over which the measurement is updated.	-
-	constantValue	bool	-	false	0	If the parameter is present, the fake sensor values never changes (useful for testing server/client coherence).	-
-	sensorName	string	-	sensorName	0	Name of the sensor	-
-	frameName	string	-	frameName	0	Name of the frame	-

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

yarpdev --device fakeIMU --period 10 --constantValue false --sensorName sensorName --frameName frameName

yarpdev --device fakeIMU

Definition at line 44 of file FakeIMU_ParamsParser.h.

Constructor & Destructor Documentation

FakeIMU_ParamsParser()

FakeIMU_ParamsParser::FakeIMU_ParamsParser

(

)

Definition at line 23 of file FakeIMU_ParamsParser.cpp.

~FakeIMU_ParamsParser()

FakeIMU_ParamsParser::~FakeIMU_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string FakeIMU_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 72 of file FakeIMU_ParamsParser.h.

getDeviceName()

std::string FakeIMU_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 73 of file FakeIMU_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeIMU_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 134 of file FakeIMU_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeIMU_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 FakeIMU_ParamsParser.cpp.

parseParams()

bool FakeIMU_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 39 of file FakeIMU_ParamsParser.cpp.

Member Data Documentation

m_constantValue

bool FakeIMU_ParamsParser::m_constantValue = {false}

Definition at line 67 of file FakeIMU_ParamsParser.h.

m_constantValue_defaultValue

const std::string FakeIMU_ParamsParser::m_constantValue_defaultValue = {"false"}

Definition at line 62 of file FakeIMU_ParamsParser.h.

m_device_classname

const std::string FakeIMU_ParamsParser::m_device_classname = {"FakeIMU"}

Definition at line 51 of file FakeIMU_ParamsParser.h.

m_device_name

const std::string FakeIMU_ParamsParser::m_device_name = {"fakeIMU"}

Definition at line 52 of file FakeIMU_ParamsParser.h.

m_frameName

std::string FakeIMU_ParamsParser::m_frameName = {"frameName"}

Definition at line 69 of file FakeIMU_ParamsParser.h.

m_frameName_defaultValue

const std::string FakeIMU_ParamsParser::m_frameName_defaultValue = {"frameName"}

Definition at line 64 of file FakeIMU_ParamsParser.h.

m_parser_is_strict

bool FakeIMU_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file FakeIMU_ParamsParser.h.

m_parser_version

const parser_version_type FakeIMU_ParamsParser::m_parser_version = {}

Definition at line 59 of file FakeIMU_ParamsParser.h.

m_period

int FakeIMU_ParamsParser::m_period = {10}

Definition at line 66 of file FakeIMU_ParamsParser.h.

m_period_defaultValue

const std::string FakeIMU_ParamsParser::m_period_defaultValue = {"10"}

Definition at line 61 of file FakeIMU_ParamsParser.h.

m_sensorName

std::string FakeIMU_ParamsParser::m_sensorName = {"sensorName"}

Definition at line 68 of file FakeIMU_ParamsParser.h.

m_sensorName_defaultValue

const std::string FakeIMU_ParamsParser::m_sensorName_defaultValue = {"sensorName"}

Definition at line 63 of file FakeIMU_ParamsParser.h.

---

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

• src/devices/fake/fakeIMU/FakeIMU_ParamsParser.h
• src/devices/fake/fakeIMU/FakeIMU_ParamsParser.cpp