YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
FakeMicrophone_ParamsParser Class Reference

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

#include <fake/fakeMicrophone/FakeMicrophone_ParamsParser.h>

+ Inheritance diagram for FakeMicrophone_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 FakeMicrophone_ParamsParser ()
 
 ~FakeMicrophone_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 = {"FakeMicrophone"}
 
const std::string m_device_name = {"fakeMicrophone"}
 
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.010"}
 
const std::string m_waveform_defaultValue = {"sine"}
 
const std::string m_signal_frequency_defaultValue = {"440"}
 
const std::string m_signal_amplitude_defaultValue = {"32000"}
 
const std::string m_driver_frame_size_defaultValue = {"512"}
 
double m_period = {0.010}
 
std::string m_waveform = {"sine"}
 
int m_signal_frequency = {440}
 
int m_signal_amplitude = {32000}
 
int m_driver_frame_size = {512}
 

Detailed Description

This class is the parameters parser for class FakeMicrophone.

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
- waveform string - sine 0 Defines the shape of the waveform. Can be one of the following: sine,sawtooth,square,constant -
- signal_frequency int Hz 440 0 Frequency of the generated signal -
- signal_amplitude int - 32000 0 Amplitude of the generated signal -
- driver_frame_size int samples 512 0 the number of samples to process on each iteration of the thread -

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

yarpdev --device fakeMicrophone --period 0.010 --waveform sine --signal_frequency 440 --signal_amplitude 32000 --driver_frame_size 512
yarpdev --device fakeMicrophone

Definition at line 45 of file FakeMicrophone_ParamsParser.h.

Constructor & Destructor Documentation

◆ FakeMicrophone_ParamsParser()

FakeMicrophone_ParamsParser::FakeMicrophone_ParamsParser ( )

Definition at line 23 of file FakeMicrophone_ParamsParser.cpp.

◆ ~FakeMicrophone_ParamsParser()

FakeMicrophone_ParamsParser::~FakeMicrophone_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string FakeMicrophone_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 74 of file FakeMicrophone_ParamsParser.cpp.

◆ getDeviceClassName()

std::string FakeMicrophone_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 77 of file FakeMicrophone_ParamsParser.h.

◆ getDeviceName()

std::string FakeMicrophone_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 78 of file FakeMicrophone_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string FakeMicrophone_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 193 of file FakeMicrophone_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > FakeMicrophone_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 FakeMicrophone_ParamsParser.cpp.

◆ getParamValue()

bool FakeMicrophone_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 40 of file FakeMicrophone_ParamsParser.cpp.

◆ parseParams()

bool FakeMicrophone_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 84 of file FakeMicrophone_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string FakeMicrophone_ParamsParser::m_device_classname = {"FakeMicrophone"}

Definition at line 52 of file FakeMicrophone_ParamsParser.h.

◆ m_device_name

const std::string FakeMicrophone_ParamsParser::m_device_name = {"fakeMicrophone"}

Definition at line 53 of file FakeMicrophone_ParamsParser.h.

◆ m_driver_frame_size

int FakeMicrophone_ParamsParser::m_driver_frame_size = {512}

Definition at line 74 of file FakeMicrophone_ParamsParser.h.

◆ m_driver_frame_size_defaultValue

const std::string FakeMicrophone_ParamsParser::m_driver_frame_size_defaultValue = {"512"}

Definition at line 68 of file FakeMicrophone_ParamsParser.h.

◆ m_parser_is_strict

bool FakeMicrophone_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file FakeMicrophone_ParamsParser.h.

◆ m_parser_version

const parser_version_type FakeMicrophone_ParamsParser::m_parser_version = {}

Definition at line 60 of file FakeMicrophone_ParamsParser.h.

◆ m_period

double FakeMicrophone_ParamsParser::m_period = {0.010}

Definition at line 70 of file FakeMicrophone_ParamsParser.h.

◆ m_period_defaultValue

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

Definition at line 64 of file FakeMicrophone_ParamsParser.h.

◆ m_provided_configuration

std::string FakeMicrophone_ParamsParser::m_provided_configuration

Definition at line 62 of file FakeMicrophone_ParamsParser.h.

◆ m_signal_amplitude

int FakeMicrophone_ParamsParser::m_signal_amplitude = {32000}

Definition at line 73 of file FakeMicrophone_ParamsParser.h.

◆ m_signal_amplitude_defaultValue

const std::string FakeMicrophone_ParamsParser::m_signal_amplitude_defaultValue = {"32000"}

Definition at line 67 of file FakeMicrophone_ParamsParser.h.

◆ m_signal_frequency

int FakeMicrophone_ParamsParser::m_signal_frequency = {440}

Definition at line 72 of file FakeMicrophone_ParamsParser.h.

◆ m_signal_frequency_defaultValue

const std::string FakeMicrophone_ParamsParser::m_signal_frequency_defaultValue = {"440"}

Definition at line 66 of file FakeMicrophone_ParamsParser.h.

◆ m_waveform

std::string FakeMicrophone_ParamsParser::m_waveform = {"sine"}

Definition at line 71 of file FakeMicrophone_ParamsParser.h.

◆ m_waveform_defaultValue

const std::string FakeMicrophone_ParamsParser::m_waveform_defaultValue = {"sine"}

Definition at line 65 of file FakeMicrophone_ParamsParser.h.

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