YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
VoiceBoxSynthesizer_ParamsParser Class Reference

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-device-voicebox/src/devices/voiceBoxSynthesizer/VoiceBoxSynthesizer_ParamsParser.h>

+ Inheritance diagram for VoiceBoxSynthesizer_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 VoiceBoxSynthesizer_ParamsParser ()
 
 ~VoiceBoxSynthesizer_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 = {"VoiceBoxSynthesizer"}
 
const std::string m_device_name = {"voiceBoxSynthesizer"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_base_ip_defaultValue = {"localhost"}
 
const std::string m_base_port_defaultValue = {"17493"}
 
const std::string m_voice_defaultValue = {""}
 
std::string m_base_ip = {"localhost"}
 
std::string m_base_port = {"17493"}
 
std::string m_voice = {}
 

Detailed Description

This class is the parameters parser for class VoiceBoxSynthesizer.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- base_ip string - localhost 0 The ip address of the voiceBox server -
- base_port string - 17493 0 The port for the voicebox address -
- voice string - - 1 The name of the voice profile To check the available profiles, either check in the VoiceBox app or use the following command: curl http://server_ip_addr:server_port/profiles

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

yarpdev --device voiceBoxSynthesizer --base_ip localhost --base_port 17493 --voice <mandatory_value>
yarpdev --device voiceBoxSynthesizer --voice <mandatory_value>

Definition at line 43 of file VoiceBoxSynthesizer_ParamsParser.h.

Constructor & Destructor Documentation

◆ VoiceBoxSynthesizer_ParamsParser()

VoiceBoxSynthesizer_ParamsParser::VoiceBoxSynthesizer_ParamsParser ( )

Definition at line 23 of file VoiceBoxSynthesizer_ParamsParser.cpp.

◆ ~VoiceBoxSynthesizer_ParamsParser()

VoiceBoxSynthesizer_ParamsParser::~VoiceBoxSynthesizer_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getConfiguration()

std::string VoiceBoxSynthesizer_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 62 of file VoiceBoxSynthesizer_ParamsParser.cpp.

◆ getDeviceClassName()

std::string VoiceBoxSynthesizer_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 71 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ getDeviceName()

std::string VoiceBoxSynthesizer_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 72 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string VoiceBoxSynthesizer_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 155 of file VoiceBoxSynthesizer_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > VoiceBoxSynthesizer_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 VoiceBoxSynthesizer_ParamsParser.cpp.

◆ getParamValue()

bool VoiceBoxSynthesizer_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 38 of file VoiceBoxSynthesizer_ParamsParser.cpp.

◆ parseParams()

bool VoiceBoxSynthesizer_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 72 of file VoiceBoxSynthesizer_ParamsParser.cpp.

Member Data Documentation

◆ m_base_ip

std::string VoiceBoxSynthesizer_ParamsParser::m_base_ip = {"localhost"}

Definition at line 66 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_base_ip_defaultValue

const std::string VoiceBoxSynthesizer_ParamsParser::m_base_ip_defaultValue = {"localhost"}

Definition at line 62 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_base_port

std::string VoiceBoxSynthesizer_ParamsParser::m_base_port = {"17493"}

Definition at line 67 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_base_port_defaultValue

const std::string VoiceBoxSynthesizer_ParamsParser::m_base_port_defaultValue = {"17493"}

Definition at line 63 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_device_classname

const std::string VoiceBoxSynthesizer_ParamsParser::m_device_classname = {"VoiceBoxSynthesizer"}

Definition at line 50 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_device_name

const std::string VoiceBoxSynthesizer_ParamsParser::m_device_name = {"voiceBoxSynthesizer"}

Definition at line 51 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_parser_is_strict

bool VoiceBoxSynthesizer_ParamsParser::m_parser_is_strict = false

Definition at line 52 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_parser_version

const parser_version_type VoiceBoxSynthesizer_ParamsParser::m_parser_version = {}

Definition at line 58 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_provided_configuration

std::string VoiceBoxSynthesizer_ParamsParser::m_provided_configuration

Definition at line 60 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_voice

std::string VoiceBoxSynthesizer_ParamsParser::m_voice = {}

Definition at line 68 of file VoiceBoxSynthesizer_ParamsParser.h.

◆ m_voice_defaultValue

const std::string VoiceBoxSynthesizer_ParamsParser::m_voice_defaultValue = {""}

Definition at line 64 of file VoiceBoxSynthesizer_ParamsParser.h.


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