YARP
Yet Another Robot Platform
yarp::os::PortablePairBase Class Reference

#include <yarp/os/PortablePair.h>

+ Inheritance diagram for yarp::os::PortablePairBase:

Detailed Description

Definition at line 23 of file PortablePair.h.

Static Public Member Functions

static bool readPair (ConnectionReader &connection, Portable &head, Portable &body)
 Reads an object pair from a network connection. More...
 
static bool writePair (ConnectionWriter &connection, const Portable &head, const Portable &body)
 Writes an object pair to a network connection. More...
 
- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading. More...
 

Additional Inherited Members

- Public Member Functions inherited from yarp::os::Portable
virtual bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
virtual 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 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
 

Member Function Documentation

◆ readPair()

bool yarp::os::PortablePairBase::readPair ( ConnectionReader connection,
Portable head,
Portable body 
)
static

Reads an object pair from a network connection.

Parameters
connectionan interface to the network connection for reading
headthe first object
bodythe second object
Returns
true iff the object pair was successfully read

Definition at line 15 of file PortablePair.cpp.

◆ writePair()

bool yarp::os::PortablePairBase::writePair ( ConnectionWriter connection,
const Portable head,
const Portable body 
)
static

Writes an object pair to a network connection.

Parameters
connectionan interface to the network connection for writing
headthe first object
bodythe second object
Returns
true iff the object pair was successfully written

Definition at line 35 of file PortablePair.cpp.


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