FakeChatBotDevice Class Reference

fakeChatBotDevice : a fake device which implements the IChatBot interface for testing purposes. More...

#include <fake/fakeChatBotDevice/FakeChatBotDevice.h>

Inheritance diagram for FakeChatBotDevice:

Public Member Functions
	FakeChatBotDevice ()
yarp::dev::ReturnValue	interact (const std::string &messageIn, std::string &messageOut) override
	Sends a message to the chatbot.
yarp::dev::ReturnValue	setLanguage (const std::string &language) override
	Sets the chat bot language.
yarp::dev::ReturnValue	getLanguage (std::string &language) override
	Gets the current chatbot language.
yarp::dev::ReturnValue	getStatus (std::string &status) override
	Gets the current status of the bot.
yarp::dev::ReturnValue	resetBot () override
	Resets the chatbot.
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
Public Member Functions inherited from yarp::dev::IChatBot
virtual	~IChatBot ()
	Destructor.
Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()
	DeviceDriver (const DeviceDriver &other)=delete
	DeviceDriver (DeviceDriver &&other) noexcept=delete
DeviceDriver &	operator= (const DeviceDriver &other)=delete
DeviceDriver &	operator= (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 DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.
Public Member Functions inherited from FakeChatBotDevice_ParamsParser
	FakeChatBotDevice_ParamsParser ()
	~FakeChatBotDevice_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 ()

Additional Inherited Members
Public Attributes inherited from FakeChatBotDevice_ParamsParser
const std::string	m_device_classname = {"FakeChatBotDevice"}
const std::string	m_device_name = {"fakeChatBotDevice"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_language_defaultValue = {"eng"}
std::string	m_language = {"eng"}

Detailed Description

fakeChatBotDevice : a fake device which implements the IChatBot interface for testing purposes.

Parameters required by this device are shown in class: FakeChatBotDevice_ParamsParser

Definition at line 23 of file FakeChatBotDevice.h.

Constructor & Destructor Documentation

FakeChatBotDevice()

FakeChatBotDevice::FakeChatBotDevice

(

)

Definition at line 14 of file FakeChatBotDevice.cpp.

Member Function Documentation

close()

bool FakeChatBotDevice::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 89 of file FakeChatBotDevice.cpp.

getLanguage()

ReturnValue FakeChatBotDevice::getLanguage ( std::string &  language )

overridevirtual

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

Implements yarp::dev::IChatBot.

Definition at line 65 of file FakeChatBotDevice.cpp.

getStatus()

ReturnValue FakeChatBotDevice::getStatus ( std::string &  status )

overridevirtual

Gets the current status of the bot.

Parameters

status

the current bot status

Returns

true on success

Implements yarp::dev::IChatBot.

Definition at line 71 of file FakeChatBotDevice.cpp.

interact()

ReturnValue FakeChatBotDevice::interact ( const std::string &  messageIn, std::string &  messageOut  )

overridevirtual

Sends a message to the chatbot.

Parameters

messageIn	the text of the input message
messageOut	the output message

Returns

true/false

Implements yarp::dev::IChatBot.

Definition at line 30 of file FakeChatBotDevice.cpp.

open()

bool FakeChatBotDevice::open ( yarp::os::Searchable &  config )

overridevirtual

Open the DeviceDriver.

Parameters

config

is 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 83 of file FakeChatBotDevice.cpp.

resetBot()

ReturnValue FakeChatBotDevice::resetBot ( )

overridevirtual

Resets the chatbot.

Returns

true on success

Implements yarp::dev::IChatBot.

Definition at line 77 of file FakeChatBotDevice.cpp.

setLanguage()

ReturnValue FakeChatBotDevice::setLanguage ( const std::string &  language )

overridevirtual

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

Implements yarp::dev::IChatBot.

Definition at line 53 of file FakeChatBotDevice.cpp.

---

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

• src/devices/fake/fakeChatBotDevice/FakeChatBotDevice.h
• src/devices/fake/fakeChatBotDevice/FakeChatBotDevice.cpp