FakeSpeaker_ParamsParser Class Reference

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

#include <fake/fakeSpeaker/FakeSpeaker_ParamsParser.h>

Inheritance diagram for FakeSpeaker_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeSpeaker_ParamsParser ()
	~FakeSpeaker_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 = {"FakeSpeaker"}
const std::string	m_device_name = {"fakeSpeaker"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_period_defaultValue = {"0.010"}
double	m_period = {0.010}

Detailed Description

This class is the parameters parser for class FakeSpeaker.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	period	double	s	0.010	0	the period of processing thread	A value of 10ms is recommended. Do to not modify it

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

yarpdev --device fakeSpeaker --period 0.010

yarpdev --device fakeSpeaker

Definition at line 41 of file FakeSpeaker_ParamsParser.h.

Constructor & Destructor Documentation

FakeSpeaker_ParamsParser()

FakeSpeaker_ParamsParser::FakeSpeaker_ParamsParser

(

)

Definition at line 23 of file FakeSpeaker_ParamsParser.cpp.

~FakeSpeaker_ParamsParser()

FakeSpeaker_ParamsParser::~FakeSpeaker_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string FakeSpeaker_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 63 of file FakeSpeaker_ParamsParser.h.

getDeviceName()

std::string FakeSpeaker_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 64 of file FakeSpeaker_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeSpeaker_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 89 of file FakeSpeaker_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeSpeaker_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 FakeSpeaker_ParamsParser.cpp.

parseParams()

bool FakeSpeaker_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 36 of file FakeSpeaker_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string FakeSpeaker_ParamsParser::m_device_classname = {"FakeSpeaker"}

Definition at line 48 of file FakeSpeaker_ParamsParser.h.

m_device_name

const std::string FakeSpeaker_ParamsParser::m_device_name = {"fakeSpeaker"}

Definition at line 49 of file FakeSpeaker_ParamsParser.h.

m_parser_is_strict

bool FakeSpeaker_ParamsParser::m_parser_is_strict = false

Definition at line 50 of file FakeSpeaker_ParamsParser.h.

m_parser_version

const parser_version_type FakeSpeaker_ParamsParser::m_parser_version = {}

Definition at line 56 of file FakeSpeaker_ParamsParser.h.

m_period

double FakeSpeaker_ParamsParser::m_period = {0.010}

Definition at line 60 of file FakeSpeaker_ParamsParser.h.

m_period_defaultValue

const std::string FakeSpeaker_ParamsParser::m_period_defaultValue = {"0.010"}

Definition at line 58 of file FakeSpeaker_ParamsParser.h.

---

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

• src/devices/fake/fakeSpeaker/FakeSpeaker_ParamsParser.h
• src/devices/fake/fakeSpeaker/FakeSpeaker_ParamsParser.cpp