YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches

chatBot_nwc_yarp: The client side of any IChatBot capable device. More...

#include <networkWrappers/chatBot_nwc_yarp/ChatBot_nwc_yarp.h>

+ Inheritance diagram for ChatBot_nwc_yarp:

Public Member Functions

bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool interact (const std::string &messageIn, std::string &messageOut) override
 Sends a message to the chatbot.
 
bool setLanguage (const std::string &language) override
 Sets the chat bot language.
 
bool getLanguage (std::string &language) override
 Gets the current chatbot language.
 
bool getStatus (std::string &status) override
 Gets the current status of the bot.
 
bool resetBot () override
 Resets the chatbot.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::dev::IChatBot
virtual ~IChatBot ()
 Destructor.
 
- Public Member Functions inherited from ChatBot_nwc_yarp_ParamsParser
 ChatBot_nwc_yarp_ParamsParser ()
 
 ~ChatBot_nwc_yarp_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 ()
 

Protected Attributes

IChatBotMsgs m_thriftClient
 
yarp::os::Port m_thriftClientPort
 

Additional Inherited Members

- Public Attributes inherited from ChatBot_nwc_yarp_ParamsParser
const std::string m_device_classname = {"ChatBot_nwc_yarp"}
 
const std::string m_device_name = {"chatBot_nwc_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_local_defaultValue = {""}
 
const std::string m_remote_defaultValue = {""}
 
std::string m_local = {}
 
std::string m_remote = {}
 

Detailed Description

chatBot_nwc_yarp: The client side of any IChatBot capable device.

Parameters required by this device are shown in class: ChatBot_nwc_yarp_ParamsParser

Definition at line 23 of file ChatBot_nwc_yarp.h.

Member Function Documentation

◆ close()

bool ChatBot_nwc_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 47 of file ChatBot_nwc_yarp.cpp.

◆ getLanguage()

bool ChatBot_nwc_yarp::getLanguage ( std::string &  language)
overridevirtual

Gets the current chatbot language.

Parameters
languagethe returned string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".
Returns
true on success

Implements yarp::dev::IChatBot.

Definition at line 76 of file ChatBot_nwc_yarp.cpp.

◆ getStatus()

bool ChatBot_nwc_yarp::getStatus ( std::string &  status)
overridevirtual

Gets the current status of the bot.

Parameters
statusthe current bot status
Returns
true on success

Implements yarp::dev::IChatBot.

Definition at line 88 of file ChatBot_nwc_yarp.cpp.

◆ interact()

bool ChatBot_nwc_yarp::interact ( const std::string &  messageIn,
std::string &  messageOut 
)
overridevirtual

Sends a message to the chatbot.

Parameters
messageInthe text of the input message
messageOutthe output message
Returns
true/false

Implements yarp::dev::IChatBot.

Definition at line 53 of file ChatBot_nwc_yarp.cpp.

◆ open()

bool ChatBot_nwc_yarp::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 16 of file ChatBot_nwc_yarp.cpp.

◆ resetBot()

bool ChatBot_nwc_yarp::resetBot ( )
overridevirtual

Resets the chatbot.

Returns
true on success

Implements yarp::dev::IChatBot.

Definition at line 100 of file ChatBot_nwc_yarp.cpp.

◆ setLanguage()

bool ChatBot_nwc_yarp::setLanguage ( const std::string &  language)
overridevirtual

Sets the chat bot language.

Parameters
languagea string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".
Returns
true on success

Implements yarp::dev::IChatBot.

Definition at line 66 of file ChatBot_nwc_yarp.cpp.

Member Data Documentation

◆ m_thriftClient

IChatBotMsgs ChatBot_nwc_yarp::m_thriftClient
protected

Definition at line 29 of file ChatBot_nwc_yarp.h.

◆ m_thriftClientPort

yarp::os::Port ChatBot_nwc_yarp::m_thriftClientPort
protected

Definition at line 32 of file ChatBot_nwc_yarp.h.


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