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

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-azure-openai/src/devices/whisperDevice/WhisperDevice_ParamsParser.h>

+ Inheritance diagram for WhisperDevice_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 WhisperDevice_ParamsParser ()
 
 ~WhisperDevice_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 ()
 
virtual bool getParamValue (const std::string &paramName, std::string &paramValue) const =0
 Return the value (represented as a string) of the requested parameter.
 
virtual std::string getConfiguration () const =0
 Return the configuration of the device.
 

Public Attributes

const std::string m_device_classname = {"WhisperDevice"}
 
const std::string m_device_name = {"whisperDevice"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_ENVS_end_point_name_defaultValue = {"AZURE_ENDPOINT"}
 
const std::string m_ENVS_deployment_id_name_defaultValue = {"DEPLOYMENT_WHISPER_ID"}
 
const std::string m_ENVS_api_key_name_defaultValue = {"AZURE_API_KEY"}
 
const std::string m_ENVS_api_version_name_defaultValue = {"AZURE_API_VERSION_TTS"}
 
std::string m_ENVS_end_point_name = {"AZURE_ENDPOINT"}
 
std::string m_ENVS_deployment_id_name = {"DEPLOYMENT_WHISPER_ID"}
 
std::string m_ENVS_api_key_name = {"AZURE_API_KEY"}
 
std::string m_ENVS_api_version_name = {"AZURE_API_VERSION_TTS"}
 

Detailed Description

This class is the parameters parser for class WhisperDevice.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
ENVS end_point_name string - AZURE_ENDPOINT 0 The name of the environmental variable that stores the APIs endpoint Here are additional notes
ENVS deployment_id_name string - DEPLOYMENT_WHISPER_ID 0 The name of the environmental variable that stores the deployment ID Here are additional notes
ENVS api_key_name string - AZURE_API_KEY 0 The name of the environmental variable that stores the APIs access key The default value is the gravity constant
ENVS api_version_name string - AZURE_API_VERSION_TTS 0 The name of the environmental variable that stores the APIs version used The default value is the gravity constant

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

yarpdev --device whisperDevice --ENVS::end_point_name AZURE_ENDPOINT --ENVS::deployment_id_name DEPLOYMENT_WHISPER_ID --ENVS::api_key_name AZURE_API_KEY --ENVS::api_version_name AZURE_API_VERSION_TTS
yarpdev --device whisperDevice

Definition at line 44 of file WhisperDevice_ParamsParser.h.

Constructor & Destructor Documentation

◆ WhisperDevice_ParamsParser()

WhisperDevice_ParamsParser::WhisperDevice_ParamsParser ( )

Definition at line 23 of file WhisperDevice_ParamsParser.cpp.

◆ ~WhisperDevice_ParamsParser()

WhisperDevice_ParamsParser::~WhisperDevice_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

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

◆ getDeviceName()

std::string WhisperDevice_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 73 of file WhisperDevice_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string WhisperDevice_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 142 of file WhisperDevice_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > WhisperDevice_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 WhisperDevice_ParamsParser.cpp.

◆ parseParams()

bool WhisperDevice_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 39 of file WhisperDevice_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string WhisperDevice_ParamsParser::m_device_classname = {"WhisperDevice"}

Definition at line 51 of file WhisperDevice_ParamsParser.h.

◆ m_device_name

const std::string WhisperDevice_ParamsParser::m_device_name = {"whisperDevice"}

Definition at line 52 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_api_key_name

std::string WhisperDevice_ParamsParser::m_ENVS_api_key_name = {"AZURE_API_KEY"}

Definition at line 68 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_api_key_name_defaultValue

const std::string WhisperDevice_ParamsParser::m_ENVS_api_key_name_defaultValue = {"AZURE_API_KEY"}

Definition at line 63 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_api_version_name

std::string WhisperDevice_ParamsParser::m_ENVS_api_version_name = {"AZURE_API_VERSION_TTS"}

Definition at line 69 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_api_version_name_defaultValue

const std::string WhisperDevice_ParamsParser::m_ENVS_api_version_name_defaultValue = {"AZURE_API_VERSION_TTS"}

Definition at line 64 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_deployment_id_name

std::string WhisperDevice_ParamsParser::m_ENVS_deployment_id_name = {"DEPLOYMENT_WHISPER_ID"}

Definition at line 67 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_deployment_id_name_defaultValue

const std::string WhisperDevice_ParamsParser::m_ENVS_deployment_id_name_defaultValue = {"DEPLOYMENT_WHISPER_ID"}

Definition at line 62 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_end_point_name

std::string WhisperDevice_ParamsParser::m_ENVS_end_point_name = {"AZURE_ENDPOINT"}

Definition at line 66 of file WhisperDevice_ParamsParser.h.

◆ m_ENVS_end_point_name_defaultValue

const std::string WhisperDevice_ParamsParser::m_ENVS_end_point_name_defaultValue = {"AZURE_ENDPOINT"}

Definition at line 61 of file WhisperDevice_ParamsParser.h.

◆ m_parser_is_strict

bool WhisperDevice_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file WhisperDevice_ParamsParser.h.

◆ m_parser_version

const parser_version_type WhisperDevice_ParamsParser::m_parser_version = {}

Definition at line 59 of file WhisperDevice_ParamsParser.h.

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