yarp::os::idl::UnwrappedView< T > Class Template Reference

#include <yarp/os/idl/Unwrapped.h>

Inheritance diagram for yarp::os::idl::UnwrappedView< T >:

Public Member Functions
	UnwrappedView (T &content)
bool	read (yarp::os::ConnectionReader &reader) override
	Read this object from a network connection. More...
bool	write (yarp::os::ConnectionWriter &writer) const override
	Write this object to a network connection. More...
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor. More...
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor. 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
T &	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. More...

Detailed Description

template<class T>
class yarp::os::idl::UnwrappedView< T >

Definition at line 40 of file Unwrapped.h.

Constructor & Destructor Documentation

UnwrappedView()

template<class T >

yarp::os::idl::UnwrappedView< T >::UnwrappedView ( T &  content )

inline

Definition at line 45 of file Unwrapped.h.

Member Function Documentation

read()

template<class T >

bool yarp::os::idl::UnwrappedView< T >::read ( yarp::os::ConnectionReader &  reader )

inlineoverridevirtual

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 47 of file Unwrapped.h.

write()

template<class T >

bool yarp::os::idl::UnwrappedView< T >::write ( yarp::os::ConnectionWriter &  writer ) const

inlineoverridevirtual

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 53 of file Unwrapped.h.

Member Data Documentation

content

template<class T >

T& yarp::os::idl::UnwrappedView< T >::content

Definition at line 43 of file Unwrapped.h.

---

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

• src/libYARP_os/src/yarp/os/idl/Unwrapped.h