yarp::dev::llm::return_readPrompt Class Reference

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

Inheritance diagram for yarp::dev::llm::return_readPrompt:

Public Types
typedef yarp::os::idl::Unwrapped< return_readPrompt >	unwrapped

Public Member Functions
	return_readPrompt ()=default
	return_readPrompt (const yarp::dev::ReturnValue &ret, const std::string &prompt)
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
yarp::dev::ReturnValue	ret {}
std::string	prompt {}

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 20 of file return_readPrompt.h.

Member Typedef Documentation

unwrapped

typedef yarp::os::idl::Unwrapped<return_readPrompt> yarp::dev::llm::return_readPrompt::unwrapped

Definition at line 51 of file return_readPrompt.h.

Constructor & Destructor Documentation

return_readPrompt() [1/2]

yarp::dev::llm::return_readPrompt::return_readPrompt ( )

default

return_readPrompt() [2/2]

yarp::dev::llm::return_readPrompt::return_readPrompt	(	const yarp::dev::ReturnValue &	ret,
		const std::string &	prompt
	)

Definition at line 16 of file return_readPrompt.cpp.

Member Function Documentation

read() [1/2]

bool yarp::dev::llm::return_readPrompt::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an 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 return_readPrompt.cpp.

read() [2/2]

bool yarp::dev::llm::return_readPrompt::read ( yarp::os::idl::WireReader &  reader )

overridevirtual

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

Definition at line 25 of file return_readPrompt.cpp.

toString()

std::string yarp::dev::llm::return_readPrompt::toString

(

)

const

Definition at line 81 of file return_readPrompt.cpp.

write() [1/2]

bool yarp::dev::llm::return_readPrompt::write ( const yarp::os::idl::WireWriter &  writer ) const

overridevirtual

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

Definition at line 53 of file return_readPrompt.cpp.

write() [2/2]

bool yarp::dev::llm::return_readPrompt::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

writer

an 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 return_readPrompt.cpp.

Member Data Documentation

prompt

std::string yarp::dev::llm::return_readPrompt::prompt {}

Definition at line 26 of file return_readPrompt.h.

ret

yarp::dev::ReturnValue yarp::dev::llm::return_readPrompt::ret {}

Definition at line 25 of file return_readPrompt.h.

---

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

• src/devices/messages/ILLMMsgs/idl_generated_code/yarp/dev/llm/return_readPrompt.h
• src/devices/messages/ILLMMsgs/idl_generated_code/yarp/dev/llm/return_readPrompt.cpp