YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::llm::Message Class Reference

#include <ILLMMsgs/idl_generated_code/yarp/dev/llm/Message.h>

+ Inheritance diagram for yarp::dev::llm::Message:

Public Types

typedef yarp::os::idl::Unwrapped< Messageunwrapped
 

Public Member Functions

 Message ()=default
 
 Message (const std::string &sender, const std::string &content)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

std::string sender {}
 
std::string content {}
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 

Detailed Description

Definition at line 19 of file Message.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ Message() [1/2]

yarp::dev::llm::Message::Message ( )
default

◆ Message() [2/2]

yarp::dev::llm::Message::Message ( const std::string &  sender,
const std::string &  content 
)

Definition at line 16 of file Message.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::llm::Message::read ( yarp::os::ConnectionReader reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

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

Implements yarp::os::Portable.

Definition at line 40 of file Message.cpp.

◆ read() [2/2]

bool yarp::dev::llm::Message::read ( yarp::os::idl::WireReader reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 25 of file Message.cpp.

◆ toString()

std::string yarp::dev::llm::Message::toString ( ) const

Definition at line 81 of file Message.cpp.

◆ write() [1/2]

bool yarp::dev::llm::Message::write ( const yarp::os::idl::WireWriter writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 53 of file Message.cpp.

◆ write() [2/2]

bool yarp::dev::llm::Message::write ( yarp::os::ConnectionWriter writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 68 of file Message.cpp.

Member Data Documentation

◆ content

std::string yarp::dev::llm::Message::content {}

Definition at line 25 of file Message.h.

◆ sender

std::string yarp::dev::llm::Message::sender {}

Definition at line 24 of file Message.h.


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