FakeNavigation_ParamsParser Class Reference

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

#include <fake/fakeNavigationDevice/FakeNavigation_ParamsParser.h>

Inheritance diagram for FakeNavigation_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeNavigation_ParamsParser ()
	~FakeNavigation_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 = {"FakeNavigation"}
const std::string	m_device_name = {"fakeNavigation"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_navigation_time_defaultValue = {"500"}
const std::string	m_reached_time_defaultValue = {"100"}
int	m_navigation_time = {500}
int	m_reached_time = {100}

Detailed Description

This class is the parameters parser for class FakeNavigation.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	navigation_time	int	-	500	0	navigation_time	-
-	reached_time	int	-	100	0	reached_time	-

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

yarpdev --device fakeNavigation --navigation_time 500 --reached_time 100

yarpdev --device fakeNavigation

Definition at line 42 of file FakeNavigation_ParamsParser.h.

Constructor & Destructor Documentation

FakeNavigation_ParamsParser()

FakeNavigation_ParamsParser::FakeNavigation_ParamsParser

(

)

Definition at line 23 of file FakeNavigation_ParamsParser.cpp.

~FakeNavigation_ParamsParser()

FakeNavigation_ParamsParser::~FakeNavigation_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string FakeNavigation_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 66 of file FakeNavigation_ParamsParser.h.

getDeviceName()

std::string FakeNavigation_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 67 of file FakeNavigation_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeNavigation_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 104 of file FakeNavigation_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeNavigation_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 FakeNavigation_ParamsParser.cpp.

parseParams()

bool FakeNavigation_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 37 of file FakeNavigation_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FakeNavigation_ParamsParser::m_device_classname = {"FakeNavigation"}

Definition at line 49 of file FakeNavigation_ParamsParser.h.

m_device_name

const std::string FakeNavigation_ParamsParser::m_device_name = {"fakeNavigation"}

Definition at line 50 of file FakeNavigation_ParamsParser.h.

m_navigation_time

int FakeNavigation_ParamsParser::m_navigation_time = {500}

Definition at line 62 of file FakeNavigation_ParamsParser.h.

m_navigation_time_defaultValue

const std::string FakeNavigation_ParamsParser::m_navigation_time_defaultValue = {"500"}

Definition at line 59 of file FakeNavigation_ParamsParser.h.

m_parser_is_strict

bool FakeNavigation_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file FakeNavigation_ParamsParser.h.

m_parser_version

const parser_version_type FakeNavigation_ParamsParser::m_parser_version = {}

Definition at line 57 of file FakeNavigation_ParamsParser.h.

m_reached_time

int FakeNavigation_ParamsParser::m_reached_time = {100}

Definition at line 63 of file FakeNavigation_ParamsParser.h.

m_reached_time_defaultValue

const std::string FakeNavigation_ParamsParser::m_reached_time_defaultValue = {"100"}

Definition at line 60 of file FakeNavigation_ParamsParser.h.

---

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

• src/devices/fake/fakeNavigationDevice/FakeNavigation_ParamsParser.h
• src/devices/fake/fakeNavigationDevice/FakeNavigation_ParamsParser.cpp