FakePositionSensor_ParamsParser Class Reference

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

#include <fake/fakePositionSensor/FakePositionSensor_ParamsParser.h>

Inheritance diagram for FakePositionSensor_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakePositionSensor_ParamsParser ()
	~FakePositionSensor_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 = {"FakePositionSensor"}
const std::string	m_device_name = {"fakePositionSensor"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_period_defaultValue = {"0.01"}
double	m_period = {0.01}

Detailed Description

This class is the parameters parser for class FakePositionSensor.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	double	s	0.01	0	thread period	optional, default 1.0s

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

yarpdev --device fakePositionSensor --period 0.01

yarpdev --device fakePositionSensor

Definition at line 41 of file FakePositionSensor_ParamsParser.h.

Constructor & Destructor Documentation

FakePositionSensor_ParamsParser()

FakePositionSensor_ParamsParser::FakePositionSensor_ParamsParser

(

)

Definition at line 23 of file FakePositionSensor_ParamsParser.cpp.

~FakePositionSensor_ParamsParser()

FakePositionSensor_ParamsParser::~FakePositionSensor_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string FakePositionSensor_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 FakePositionSensor_ParamsParser.cpp.

getDeviceClassName()

std::string FakePositionSensor_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 FakePositionSensor_ParamsParser.h.

getDeviceName()

std::string FakePositionSensor_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 FakePositionSensor_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakePositionSensor_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 113 of file FakePositionSensor_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakePositionSensor_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 FakePositionSensor_ParamsParser.cpp.

getParamValue()

bool FakePositionSensor_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 FakePositionSensor_ParamsParser.cpp.

parseParams()

bool FakePositionSensor_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 FakePositionSensor_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FakePositionSensor_ParamsParser::m_device_classname = {"FakePositionSensor"}

Definition at line 48 of file FakePositionSensor_ParamsParser.h.

m_device_name

const std::string FakePositionSensor_ParamsParser::m_device_name = {"fakePositionSensor"}

Definition at line 49 of file FakePositionSensor_ParamsParser.h.

m_parser_is_strict

bool FakePositionSensor_ParamsParser::m_parser_is_strict = false

Definition at line 50 of file FakePositionSensor_ParamsParser.h.

m_parser_version

const parser_version_type FakePositionSensor_ParamsParser::m_parser_version = {}

Definition at line 56 of file FakePositionSensor_ParamsParser.h.

m_period

double FakePositionSensor_ParamsParser::m_period = {0.01}

Definition at line 62 of file FakePositionSensor_ParamsParser.h.

m_period_defaultValue

const std::string FakePositionSensor_ParamsParser::m_period_defaultValue = {"0.01"}

Definition at line 60 of file FakePositionSensor_ParamsParser.h.

m_provided_configuration

std::string FakePositionSensor_ParamsParser::m_provided_configuration

Definition at line 58 of file FakePositionSensor_ParamsParser.h.

---

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

• src/devices/fake/fakePositionSensor/FakePositionSensor_ParamsParser.h
• src/devices/fake/fakePositionSensor/FakePositionSensor_ParamsParser.cpp