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

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

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-google-cloud/src/devices/googleDialogflowCxChatBot/GoogleDialogFlowCxChatBot_ParamsParser.h>

+ Inheritance diagram for GoogleDialogFlowCxChatBot_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 GoogleDialogFlowCxChatBot_ParamsParser ()
 
 ~GoogleDialogFlowCxChatBot_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 = {"GoogleDialogFlowCxChatBot"}
 
const std::string m_device_name = {"googleDialogFlowCxChatBot"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_project_defaultValue = {""}
 
const std::string m_location_defaultValue = {""}
 
const std::string m_agent_name_defaultValue = {""}
 
const std::string m_language_code_defaultValue = {"en-US"}
 
std::string m_project = {}
 
std::string m_location = {}
 
std::string m_agent_name = {}
 
std::string m_language_code = {"en-US"}
 

Detailed Description

This class is the parameters parser for class GoogleDialogFlowCxChatBot.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- project string - - 1 The name of the Google cloud project the wanted agent belongs to -
- location string - - 1 The world region specified for the wanted agent -
- agent_name string - - 1 The name of the agent -
- language_code string - en-US 0 The language code to use for the interaction with the bot -

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

yarpdev --device googleDialogFlowCxChatBot --project <mandatory_value> --location <mandatory_value> --agent_name <mandatory_value> --language_code en-US
yarpdev --device googleDialogFlowCxChatBot --project <mandatory_value> --location <mandatory_value> --agent_name <mandatory_value>

Definition at line 44 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

Constructor & Destructor Documentation

◆ GoogleDialogFlowCxChatBot_ParamsParser()

GoogleDialogFlowCxChatBot_ParamsParser::GoogleDialogFlowCxChatBot_ParamsParser ( )

Definition at line 23 of file GoogleDialogFlowCxChatBot_ParamsParser.cpp.

◆ ~GoogleDialogFlowCxChatBot_ParamsParser()

GoogleDialogFlowCxChatBot_ParamsParser::~GoogleDialogFlowCxChatBot_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string GoogleDialogFlowCxChatBot_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 GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ getDeviceName()

std::string GoogleDialogFlowCxChatBot_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 GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string GoogleDialogFlowCxChatBot_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 140 of file GoogleDialogFlowCxChatBot_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > GoogleDialogFlowCxChatBot_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 GoogleDialogFlowCxChatBot_ParamsParser.cpp.

◆ parseParams()

bool GoogleDialogFlowCxChatBot_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 GoogleDialogFlowCxChatBot_ParamsParser.cpp.

Member Data Documentation

◆ m_agent_name

std::string GoogleDialogFlowCxChatBot_ParamsParser::m_agent_name = {}

Definition at line 68 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_agent_name_defaultValue

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_agent_name_defaultValue = {""}

Definition at line 63 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_device_classname

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_device_classname = {"GoogleDialogFlowCxChatBot"}

Definition at line 51 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_device_name

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_device_name = {"googleDialogFlowCxChatBot"}

Definition at line 52 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_language_code

std::string GoogleDialogFlowCxChatBot_ParamsParser::m_language_code = {"en-US"}

Definition at line 69 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_language_code_defaultValue

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_language_code_defaultValue = {"en-US"}

Definition at line 64 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_location

std::string GoogleDialogFlowCxChatBot_ParamsParser::m_location = {}

Definition at line 67 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_location_defaultValue

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_location_defaultValue = {""}

Definition at line 62 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_parser_is_strict

bool GoogleDialogFlowCxChatBot_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_parser_version

const parser_version_type GoogleDialogFlowCxChatBot_ParamsParser::m_parser_version = {}

Definition at line 59 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_project

std::string GoogleDialogFlowCxChatBot_ParamsParser::m_project = {}

Definition at line 66 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

◆ m_project_defaultValue

const std::string GoogleDialogFlowCxChatBot_ParamsParser::m_project_defaultValue = {""}

Definition at line 61 of file GoogleDialogFlowCxChatBot_ParamsParser.h.

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