AudioToFileDevice_ParamsParser Class Reference

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

#include <audioToFileDevice/AudioToFileDevice_ParamsParser.h>

Inheritance diagram for AudioToFileDevice_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	AudioToFileDevice_ParamsParser ()
	~AudioToFileDevice_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 = {"AudioToFileDevice"}
const std::string	m_device_name = {"audioToFileDevice"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_file_name_defaultValue = {"audio_out.wav"}
const std::string	m_save_mode_defaultValue = {"overwrite_file"}
const std::string	m_add_marker_defaultValue = {"false"}
std::string	m_file_name = {"audio_out.wav"}
std::string	m_save_mode = {"overwrite_file"}
bool	m_add_marker = {false}

Detailed Description

This class is the parameters parser for class AudioToFileDevice.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	file_name	string	-	audio_out.wav	0	The name of the file written by the module	Only .wav and .mp3 files are supported
-	save_mode	string	-	overwrite_file	0	Affects the behavior of the module and defines the save mode, as described in the documentation.	-
-	add_marker	bool	-	false	0	If set, it will add a marker at the beginning and at the ending of each received waveform.	-

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

yarpdev --device audioToFileDevice --file_name audio_out.wav --save_mode overwrite_file --add_marker false

yarpdev --device audioToFileDevice

Definition at line 43 of file AudioToFileDevice_ParamsParser.h.

Constructor & Destructor Documentation

AudioToFileDevice_ParamsParser()

AudioToFileDevice_ParamsParser::AudioToFileDevice_ParamsParser

(

)

Definition at line 23 of file AudioToFileDevice_ParamsParser.cpp.

~AudioToFileDevice_ParamsParser()

AudioToFileDevice_ParamsParser::~AudioToFileDevice_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string AudioToFileDevice_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 69 of file AudioToFileDevice_ParamsParser.h.

getDeviceName()

std::string AudioToFileDevice_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 70 of file AudioToFileDevice_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string AudioToFileDevice_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 119 of file AudioToFileDevice_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > AudioToFileDevice_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 AudioToFileDevice_ParamsParser.cpp.

parseParams()

bool AudioToFileDevice_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 38 of file AudioToFileDevice_ParamsParser.cpp.

Member Data Documentation

m_add_marker

bool AudioToFileDevice_ParamsParser::m_add_marker = {false}

Definition at line 66 of file AudioToFileDevice_ParamsParser.h.

m_add_marker_defaultValue

const std::string AudioToFileDevice_ParamsParser::m_add_marker_defaultValue = {"false"}

Definition at line 62 of file AudioToFileDevice_ParamsParser.h.

m_device_classname

const std::string AudioToFileDevice_ParamsParser::m_device_classname = {"AudioToFileDevice"}

Definition at line 50 of file AudioToFileDevice_ParamsParser.h.

m_device_name

const std::string AudioToFileDevice_ParamsParser::m_device_name = {"audioToFileDevice"}

Definition at line 51 of file AudioToFileDevice_ParamsParser.h.

m_file_name

std::string AudioToFileDevice_ParamsParser::m_file_name = {"audio_out.wav"}

Definition at line 64 of file AudioToFileDevice_ParamsParser.h.

m_file_name_defaultValue

const std::string AudioToFileDevice_ParamsParser::m_file_name_defaultValue = {"audio_out.wav"}

Definition at line 60 of file AudioToFileDevice_ParamsParser.h.

m_parser_is_strict

bool AudioToFileDevice_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file AudioToFileDevice_ParamsParser.h.

m_parser_version

const parser_version_type AudioToFileDevice_ParamsParser::m_parser_version = {}

Definition at line 58 of file AudioToFileDevice_ParamsParser.h.

m_save_mode

std::string AudioToFileDevice_ParamsParser::m_save_mode = {"overwrite_file"}

Definition at line 65 of file AudioToFileDevice_ParamsParser.h.

m_save_mode_defaultValue

const std::string AudioToFileDevice_ParamsParser::m_save_mode_defaultValue = {"overwrite_file"}

Definition at line 61 of file AudioToFileDevice_ParamsParser.h.

---

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

• src/devices/audioToFileDevice/AudioToFileDevice_ParamsParser.h
• src/devices/audioToFileDevice/AudioToFileDevice_ParamsParser.cpp