Yet Another Robot Platform
No Matches

ChatBot_nws_yarp: A wrapper for a plugin able to interact with a chatbot or implementing one. More...

#include <chatBot_nws_yarp/ChatBot_nws_yarp.h>

+ Inheritance diagram for ChatBot_nws_yarp:

Public Member Functions

 ChatBot_nws_yarp ()=default
 ChatBot_nws_yarp (const ChatBot_nws_yarp &)=delete
 ChatBot_nws_yarp (ChatBot_nws_yarp &&)=delete
ChatBot_nws_yarpoperator= (const ChatBot_nws_yarp &)=delete
ChatBot_nws_yarpoperator= (ChatBot_nws_yarp &&)=delete
virtual ~ChatBot_nws_yarp () override
bool open (yarp::os::Searchable &config) override
 Initialize the object.
bool close () override
 Shut the object down.
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
- 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
 ~DeviceDriver () override
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
bool close () override
 Close the 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::os::IConfig
virtual ~IConfig ()
virtual bool configure (Searchable &config)
 Change online parameters.
- Public Member Functions inherited from yarp::dev::WrapperSingle
 ~WrapperSingle () override
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects.
bool detachAll () final
 Detach the object (you must have first called attach).
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
virtual Type getReadType () const

Detailed Description

ChatBot_nws_yarp: A wrapper for a plugin able to interact with a chatbot or implementing one.

The network interface is composed by two ports. When a text bottle is received on the input port, the attached subdevice sends it to the chatbot and sends the bot resonse on the output port The same functionality is available also via rpc port, which also provides additional functionalities, such as setting the language, resetting the bot and performing backup and restore operations.

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
name - string - /chatBot_nws No full name of the port opened by the device MUST start with a '/' character, xxx/text:i, xxx/rpc, xxx/audio:o ports are opened

Definition at line 80 of file ChatBot_nws_yarp.h.

Constructor & Destructor Documentation

◆ ChatBot_nws_yarp() [1/3]

ChatBot_nws_yarp::ChatBot_nws_yarp ( )

◆ ChatBot_nws_yarp() [2/3]

ChatBot_nws_yarp::ChatBot_nws_yarp ( const ChatBot_nws_yarp )

◆ ChatBot_nws_yarp() [3/3]

ChatBot_nws_yarp::ChatBot_nws_yarp ( ChatBot_nws_yarp &&  )

◆ ~ChatBot_nws_yarp()

ChatBot_nws_yarp::~ChatBot_nws_yarp ( )

Definition at line 16 of file ChatBot_nws_yarp.cpp.

Member Function Documentation

◆ close()

bool ChatBot_nws_yarp::close ( )

Shut the object down.

You should override this.

true/false on success/failure.

Reimplemented from yarp::os::IConfig.

Definition at line 21 of file ChatBot_nws_yarp.cpp.

◆ open()

bool ChatBot_nws_yarp::open ( yarp::os::Searchable config)

Initialize the object.

You should override this.

configis a list of parameters for the object. Which parameters are effective for your object can vary.
true/false upon success/failure

Reimplemented from yarp::os::IConfig.

Definition at line 26 of file ChatBot_nws_yarp.cpp.

◆ operator=() [1/2]

ChatBot_nws_yarp & ChatBot_nws_yarp::operator= ( ChatBot_nws_yarp &&  )

◆ operator=() [2/2]

ChatBot_nws_yarp & ChatBot_nws_yarp::operator= ( const ChatBot_nws_yarp )

◆ read()

bool ChatBot_nws_yarp::read ( yarp::os::ConnectionReader reader)

Read this object from a network connection.

Override this for your particular class.

readeran interface to the network connection for reading
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 104 of file ChatBot_nws_yarp.cpp.

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