YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::StampData Class Reference

Holds a time stamp and/or sequence number. More...

#include <idl_generated_code/yarp/os/StampData.h>

+ Inheritance diagram for yarp::os::StampData:

Public Types

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

Public Member Functions

 StampData ()=default
 
 StampData (const std::int32_t sequenceNumber, const double timeStamp)
 
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
 

Protected Attributes

std::int32_t sequenceNumber {0}
 
double timeStamp {0.0}
 

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

Holds a time stamp and/or sequence number.

Definition at line 24 of file StampData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ StampData() [1/2]

yarp::os::StampData::StampData ( )
default

◆ StampData() [2/2]

yarp::os::StampData::StampData ( const std::int32_t  sequenceNumber,
const double  timeStamp 
)

Definition at line 16 of file StampData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::os::StampData::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 40 of file StampData.cpp.

◆ read() [2/2]

bool yarp::os::StampData::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

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

Definition at line 25 of file StampData.cpp.

◆ toString()

std::string yarp::os::StampData::toString ( ) const

Definition at line 81 of file StampData.cpp.

◆ write() [1/2]

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

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

Definition at line 53 of file StampData.cpp.

◆ write() [2/2]

bool yarp::os::StampData::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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 68 of file StampData.cpp.

Member Data Documentation

◆ sequenceNumber

std::int32_t yarp::os::StampData::sequenceNumber {0}
protected

Definition at line 29 of file StampData.h.

◆ timeStamp

double yarp::os::StampData::timeStamp {0.0}
protected

Definition at line 30 of file StampData.h.


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