YARP
Yet Another Robot Platform
yarp::wire_rep_utils::WireTwiddlerWriter Class Reference

#include <yarp/wire_rep_utils/WireTwiddler.h>

+ Inheritance diagram for yarp::wire_rep_utils::WireTwiddlerWriter:

Public Member Functions

 WireTwiddlerWriter (yarp::os::SizedWriter &parent, WireTwiddler &twiddler)
 
 WireTwiddlerWriter ()
 
virtual ~WireTwiddlerWriter ()
 
void attach (yarp::os::SizedWriter &parent, WireTwiddler &twiddler)
 
bool update ()
 
size_t length () const override
 
size_t headerLength () const override
 
size_t length (size_t index) const override
 
const char * data (size_t index) const override
 
yarp::os::PortReadergetReplyHandler () override
 
yarp::os::PortablegetReference () override
 
bool skip (const char *start, int len)
 
bool transform (const WireTwiddlerGap &gap)
 
bool pass (int len)
 
bool pad (size_t len)
 
bool readLengthAndPass (int unitLength, const WireTwiddlerGap *gap=nullptr)
 
bool advance (int length, bool shouldEmit, bool shouldAccum=false, bool shouldCheck=false)
 
bool emit (const char *src, int len)
 
int readLength ()
 
bool dropRequested () override
 
void startWrite () const override
 Call when writing is about to begin. More...
 
void stopWrite () const override
 Call when all writing is finished. More...
 
- Public Member Functions inherited from yarp::os::SizedWriter
virtual ~SizedWriter ()
 
virtual void write (OutputStream &os)
 
bool write (ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
virtual void clear ()
 
- 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
 

Detailed Description

Definition at line 211 of file WireTwiddler.h.

Constructor & Destructor Documentation

◆ WireTwiddlerWriter() [1/2]

yarp::wire_rep_utils::WireTwiddlerWriter::WireTwiddlerWriter ( yarp::os::SizedWriter parent,
WireTwiddler twiddler 
)
inline

Definition at line 242 of file WireTwiddler.h.

◆ WireTwiddlerWriter() [2/2]

yarp::wire_rep_utils::WireTwiddlerWriter::WireTwiddlerWriter ( )
inline

Definition at line 270 of file WireTwiddler.h.

◆ ~WireTwiddlerWriter()

WireTwiddlerWriter::~WireTwiddlerWriter ( )
virtualdefault

Member Function Documentation

◆ advance()

bool WireTwiddlerWriter::advance ( int  length,
bool  shouldEmit,
bool  shouldAccum = false,
bool  shouldCheck = false 
)

Definition at line 871 of file WireTwiddler.cpp.

◆ attach()

void yarp::wire_rep_utils::WireTwiddlerWriter::attach ( yarp::os::SizedWriter parent,
WireTwiddler twiddler 
)
inline

Definition at line 297 of file WireTwiddler.h.

◆ data()

const char* yarp::wire_rep_utils::WireTwiddlerWriter::data ( size_t  index) const
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 318 of file WireTwiddler.h.

◆ dropRequested()

bool yarp::wire_rep_utils::WireTwiddlerWriter::dropRequested ( )
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 351 of file WireTwiddler.h.

◆ emit()

bool WireTwiddlerWriter::emit ( const char *  src,
int  len 
)

Definition at line 944 of file WireTwiddler.cpp.

◆ getReference()

yarp::os::Portable* yarp::wire_rep_utils::WireTwiddlerWriter::getReference ( )
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 329 of file WireTwiddler.h.

◆ getReplyHandler()

yarp::os::PortReader* yarp::wire_rep_utils::WireTwiddlerWriter::getReplyHandler ( )
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 325 of file WireTwiddler.h.

◆ headerLength()

size_t yarp::wire_rep_utils::WireTwiddlerWriter::headerLength ( ) const
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 310 of file WireTwiddler.h.

◆ length() [1/2]

size_t yarp::wire_rep_utils::WireTwiddlerWriter::length ( ) const
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 306 of file WireTwiddler.h.

◆ length() [2/2]

size_t yarp::wire_rep_utils::WireTwiddlerWriter::length ( size_t  index) const
inlineoverridevirtual

Implements yarp::os::SizedWriter.

Definition at line 314 of file WireTwiddler.h.

◆ pad()

bool WireTwiddlerWriter::pad ( size_t  len)

Definition at line 803 of file WireTwiddler.cpp.

◆ pass()

bool WireTwiddlerWriter::pass ( int  len)

Definition at line 799 of file WireTwiddler.cpp.

◆ readLength()

int WireTwiddlerWriter::readLength ( )

Definition at line 857 of file WireTwiddler.cpp.

◆ readLengthAndPass()

bool WireTwiddlerWriter::readLengthAndPass ( int  unitLength,
const WireTwiddlerGap gap = nullptr 
)

Definition at line 813 of file WireTwiddler.cpp.

◆ skip()

bool WireTwiddlerWriter::skip ( const char *  start,
int  len 
)

Definition at line 794 of file WireTwiddler.cpp.

◆ startWrite()

void yarp::wire_rep_utils::WireTwiddlerWriter::startWrite ( ) const
inlineoverridevirtual

Call when writing is about to begin.

Implements yarp::os::SizedWriter.

Definition at line 355 of file WireTwiddler.h.

◆ stopWrite()

void yarp::wire_rep_utils::WireTwiddlerWriter::stopWrite ( ) const
inlineoverridevirtual

Call when all writing is finished.

Implements yarp::os::SizedWriter.

Definition at line 359 of file WireTwiddler.h.

◆ transform()

bool WireTwiddlerWriter::transform ( const WireTwiddlerGap gap)

Definition at line 1001 of file WireTwiddler.cpp.

◆ update()

bool WireTwiddlerWriter::update ( )

Definition at line 722 of file WireTwiddler.cpp.


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