AudioPlayerWrapper_ParamsParser Class Reference

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

#include <networkWrappers/audioPlayerWrapper/AudioPlayerWrapper_ParamsParser.h>

Inheritance diagram for AudioPlayerWrapper_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	AudioPlayerWrapper_ParamsParser ()
	~AudioPlayerWrapper_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 = {"AudioPlayerWrapper"}
const std::string	m_device_name = {"AudioPlayerWrapper"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_name_defaultValue = {"/audioPlayerWrapper"}
const std::string	m_period_defaultValue = {"0.02"}
const std::string	m_debug_defaultValue = {"false"}
const std::string	m_playback_network_buffer_size_defaultValue = {"5.0"}
const std::string	m_start_defaultValue = {"false"}
std::string	m_name = {"/audioPlayerWrapper"}
float	m_period = {0.02}
bool	m_debug = {false}
double	m_playback_network_buffer_size = {5.0}
bool	m_start = {false}

Detailed Description

This class is the parameters parser for class AudioPlayerWrapper.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	name	string	-	/audioPlayerWrapper	0	prefix of the ports opened by the device	xxx/audio:i, xxx/rpc:i, xxx/status:o, ports are opened
-	period	float	s	0.02	0	period of the internal thread, in s	-
-	debug	bool	-	false	0	developers use only	-
-	playback_network_buffer_size	double	s	5.0	0	size of the audio buffer in seconds, increasing this value to robustify the real-time audio stream (it will increase latency too)	Audio playback will start when the buffer is full
-	start	bool	-	false	0	automatically activates the playback when the device is started	if false, the playback is enabled via rpc port

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

yarpdev --device AudioPlayerWrapper --name /audioPlayerWrapper --period 0.02 --debug false --playback_network_buffer_size 5.0 --start false

yarpdev --device AudioPlayerWrapper

Definition at line 45 of file AudioPlayerWrapper_ParamsParser.h.

Constructor & Destructor Documentation

AudioPlayerWrapper_ParamsParser()

AudioPlayerWrapper_ParamsParser::AudioPlayerWrapper_ParamsParser

(

)

Definition at line 23 of file AudioPlayerWrapper_ParamsParser.cpp.

~AudioPlayerWrapper_ParamsParser()

AudioPlayerWrapper_ParamsParser::~AudioPlayerWrapper_ParamsParser ( )

overridedefault

Member Function Documentation

getConfiguration()

std::string AudioPlayerWrapper_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 76 of file AudioPlayerWrapper_ParamsParser.cpp.

getDeviceClassName()

std::string AudioPlayerWrapper_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 AudioPlayerWrapper_ParamsParser.h.

getDeviceName()

std::string AudioPlayerWrapper_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 AudioPlayerWrapper_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string AudioPlayerWrapper_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 195 of file AudioPlayerWrapper_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > AudioPlayerWrapper_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 AudioPlayerWrapper_ParamsParser.cpp.

getParamValue()

bool AudioPlayerWrapper_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 AudioPlayerWrapper_ParamsParser.cpp.

parseParams()

bool AudioPlayerWrapper_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 86 of file AudioPlayerWrapper_ParamsParser.cpp.

Member Data Documentation

m_debug

bool AudioPlayerWrapper_ParamsParser::m_debug = {false}

Definition at line 72 of file AudioPlayerWrapper_ParamsParser.h.

m_debug_defaultValue

const std::string AudioPlayerWrapper_ParamsParser::m_debug_defaultValue = {"false"}

Definition at line 66 of file AudioPlayerWrapper_ParamsParser.h.

m_device_classname

const std::string AudioPlayerWrapper_ParamsParser::m_device_classname = {"AudioPlayerWrapper"}

Definition at line 52 of file AudioPlayerWrapper_ParamsParser.h.

m_device_name

const std::string AudioPlayerWrapper_ParamsParser::m_device_name = {"AudioPlayerWrapper"}

Definition at line 53 of file AudioPlayerWrapper_ParamsParser.h.

m_name

std::string AudioPlayerWrapper_ParamsParser::m_name = {"/audioPlayerWrapper"}

Definition at line 70 of file AudioPlayerWrapper_ParamsParser.h.

m_name_defaultValue

const std::string AudioPlayerWrapper_ParamsParser::m_name_defaultValue = {"/audioPlayerWrapper"}

Definition at line 64 of file AudioPlayerWrapper_ParamsParser.h.

m_parser_is_strict

bool AudioPlayerWrapper_ParamsParser::m_parser_is_strict = false

Definition at line 54 of file AudioPlayerWrapper_ParamsParser.h.

m_parser_version

const parser_version_type AudioPlayerWrapper_ParamsParser::m_parser_version = {}

Definition at line 60 of file AudioPlayerWrapper_ParamsParser.h.

m_period

float AudioPlayerWrapper_ParamsParser::m_period = {0.02}

Definition at line 71 of file AudioPlayerWrapper_ParamsParser.h.

m_period_defaultValue

const std::string AudioPlayerWrapper_ParamsParser::m_period_defaultValue = {"0.02"}

Definition at line 65 of file AudioPlayerWrapper_ParamsParser.h.

m_playback_network_buffer_size

double AudioPlayerWrapper_ParamsParser::m_playback_network_buffer_size = {5.0}

Definition at line 73 of file AudioPlayerWrapper_ParamsParser.h.

m_playback_network_buffer_size_defaultValue

const std::string AudioPlayerWrapper_ParamsParser::m_playback_network_buffer_size_defaultValue = {"5.0"}

Definition at line 67 of file AudioPlayerWrapper_ParamsParser.h.

m_provided_configuration

std::string AudioPlayerWrapper_ParamsParser::m_provided_configuration

Definition at line 62 of file AudioPlayerWrapper_ParamsParser.h.

m_start

bool AudioPlayerWrapper_ParamsParser::m_start = {false}

Definition at line 74 of file AudioPlayerWrapper_ParamsParser.h.

m_start_defaultValue

const std::string AudioPlayerWrapper_ParamsParser::m_start_defaultValue = {"false"}

Definition at line 68 of file AudioPlayerWrapper_ParamsParser.h.

---

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

• src/devices/networkWrappers/audioPlayerWrapper/AudioPlayerWrapper_ParamsParser.h
• src/devices/networkWrappers/audioPlayerWrapper/AudioPlayerWrapper_ParamsParser.cpp