return_get_areas_list Class Reference

#include <messages/IMap2DMsgs/idl_generated_code/return_get_areas_list.h>

Inheritance diagram for return_get_areas_list:

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

Public Member Functions
	return_get_areas_list ()=default
	return_get_areas_list (const bool retval, const std::vector< std::string > &areas)
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
bool	retval {false}
std::vector< std::string >	areas {}

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 17 of file return_get_areas_list.h.

Member Typedef Documentation

unwrapped

typedef yarp::os::idl::Unwrapped<return_get_areas_list> return_get_areas_list::unwrapped

Definition at line 48 of file return_get_areas_list.h.

Constructor & Destructor Documentation

return_get_areas_list() [1/2]

return_get_areas_list::return_get_areas_list ( )

default

return_get_areas_list() [2/2]

return_get_areas_list::return_get_areas_list	(	const bool	retval,
		const std::vector< std::string > &	areas
	)

Definition at line 14 of file return_get_areas_list.cpp.

Member Function Documentation

read() [1/2]

bool return_get_areas_list::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 38 of file return_get_areas_list.cpp.

read() [2/2]

bool return_get_areas_list::read ( yarp::os::idl::WireReader &  reader )

overridevirtual

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

Definition at line 23 of file return_get_areas_list.cpp.

toString()

std::string return_get_areas_list::toString

(

)

const

Definition at line 79 of file return_get_areas_list.cpp.

write() [1/2]

bool return_get_areas_list::write ( const yarp::os::idl::WireWriter &  writer ) const

overridevirtual

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

Definition at line 51 of file return_get_areas_list.cpp.

write() [2/2]

bool return_get_areas_list::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 66 of file return_get_areas_list.cpp.

Member Data Documentation

areas

std::vector<std::string> return_get_areas_list::areas {}

Definition at line 23 of file return_get_areas_list.h.

retval

bool return_get_areas_list::retval {false}

Definition at line 22 of file return_get_areas_list.h.

---

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

• src/devices/messages/IMap2DMsgs/idl_generated_code/return_get_areas_list.h
• src/devices/messages/IMap2DMsgs/idl_generated_code/return_get_areas_list.cpp