yarp::os::CommandBottle Class Reference

#include <yarp/os/CommandBottle.h>

Inheritance diagram for yarp::os::CommandBottle:

Public Member Functions
	CommandBottle ()=default
	CommandBottle (const std::string &text)
	CommandBottle (std::initializer_list< yarp::os::Value > values)
	CommandBottle (const CommandBottle &rhs)=default
	CommandBottle (CommandBottle &&rhs) noexcept=default
CommandBottle &	operator= (const CommandBottle &rhs)=default
CommandBottle &	operator= (CommandBottle &&rhs) noexcept=default
	~CommandBottle () override=default
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection. More...
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection. More...
Public Member Functions inherited from yarp::os::Portable
bool	read (ConnectionReader &reader) override=0
	Read this object from a network connection. More...
bool	write (ConnectionWriter &writer) const override=0
	Write this object to a network connection. More...
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor. More...
virtual bool	read (ConnectionReader &reader)=0
	Read this object from a network connection. More...
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor. More...
virtual bool	write (ConnectionWriter &writer) const =0
	Write this object to a network connection. More...
virtual void	onCompletion () const
	This is called when the port has finished all writing operations. More...
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations. More...
virtual yarp::os::Type	getWriteType () const

Public Attributes
yarp::os::Bottle	cmd
yarp::os::Bottle	reply

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. More...

Detailed Description

Definition at line 21 of file CommandBottle.h.

Constructor & Destructor Documentation

CommandBottle() [1/5]

yarp::os::CommandBottle::CommandBottle ( )

default

CommandBottle() [2/5]

CommandBottle::CommandBottle ( const std::string &  text )

explicit

Definition at line 10 of file CommandBottle.cpp.

CommandBottle() [3/5]

CommandBottle::CommandBottle ( std::initializer_list< yarp::os::Value >  values )

explicit

Definition at line 15 of file CommandBottle.cpp.

CommandBottle() [4/5]

yarp::os::CommandBottle::CommandBottle ( const CommandBottle &  rhs )

default

CommandBottle() [5/5]

yarp::os::CommandBottle::CommandBottle ( CommandBottle &&  rhs )

defaultnoexcept

~CommandBottle()

yarp::os::CommandBottle::~CommandBottle ( )

overridedefault

Member Function Documentation

operator=() [1/2]

CommandBottle & yarp::os::CommandBottle::operator= ( CommandBottle &&  rhs )

defaultnoexcept

operator=() [2/2]

CommandBottle & yarp::os::CommandBottle::operator= ( const CommandBottle &  rhs )

default

read()

bool CommandBottle::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 25 of file CommandBottle.cpp.

write()

bool CommandBottle::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 20 of file CommandBottle.cpp.

Member Data Documentation

cmd

yarp::os::Bottle yarp::os::CommandBottle::cmd

Definition at line 39 of file CommandBottle.h.

reply

yarp::os::Bottle yarp::os::CommandBottle::reply

Definition at line 40 of file CommandBottle.h.

---

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

• src/libYARP_os/src/yarp/os/CommandBottle.h
• src/libYARP_os/src/yarp/os/CommandBottle.cpp