yarp::dev::IChatBot Class Reference

IChatBot interface. More...

#include <yarp/dev/IChatBot.h>

Inheritance diagram for yarp::dev::IChatBot:

Public Member Functions
virtual	~IChatBot ()
	Destructor.
virtual yarp::dev::ReturnValue	interact (const std::string &messageIn, std::string &messageOut)=0
	Sends a message to the chatbot.
virtual yarp::dev::ReturnValue	setLanguage (const std::string &language="auto")=0
	Sets the chat bot language.
virtual yarp::dev::ReturnValue	getLanguage (std::string &language)=0
	Gets the current chatbot language.
virtual yarp::dev::ReturnValue	getStatus (std::string &status)=0
	Gets the current status of the bot.
virtual yarp::dev::ReturnValue	resetBot ()=0
	Resets the chatbot.

Detailed Description

IChatBot interface.

Provides methods to interact with chatbots.

Definition at line 25 of file IChatBot.h.

Constructor & Destructor Documentation

~IChatBot()

yarp::dev::IChatBot::~IChatBot ( )

virtualdefault

Destructor.

Member Function Documentation

getLanguage()

virtual yarp::dev::ReturnValue yarp::dev::IChatBot::getLanguage ( std::string &  language )

pure virtual

Gets the current chatbot language.

Parameters

language

the returned string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".

Returns

true on success

Implemented in GoogleDialogFlowCxChatBot, FakeChatBotDevice, and ChatBot_nwc_yarp.

getStatus()

virtual yarp::dev::ReturnValue yarp::dev::IChatBot::getStatus ( std::string &  status )

pure virtual

Gets the current status of the bot.

Parameters

status

the current bot status

Returns

true on success

Implemented in GoogleDialogFlowCxChatBot, FakeChatBotDevice, and ChatBot_nwc_yarp.

interact()

virtual yarp::dev::ReturnValue yarp::dev::IChatBot::interact ( const std::string &  messageIn, std::string &  messageOut  )

pure virtual

Sends a message to the chatbot.

Parameters

messageIn	the text of the input message
messageOut	the output message

Returns

true/false

Implemented in GoogleDialogFlowCxChatBot, FakeChatBotDevice, and ChatBot_nwc_yarp.

resetBot()

virtual yarp::dev::ReturnValue yarp::dev::IChatBot::resetBot ( )

pure virtual

Resets the chatbot.

Returns

true on success

Implemented in GoogleDialogFlowCxChatBot, FakeChatBotDevice, and ChatBot_nwc_yarp.

setLanguage()

virtual yarp::dev::ReturnValue yarp::dev::IChatBot::setLanguage ( const std::string &  language = "auto" )

pure virtual

Sets the chat bot language.

Parameters

language

a string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".

Returns

true on success

Implemented in GoogleDialogFlowCxChatBot, FakeChatBotDevice, and ChatBot_nwc_yarp.

---

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

• src/libYARP_dev/src/yarp/dev/IChatBot.h
• src/libYARP_dev/src/yarp/dev/IChatBot.cpp