YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::math::FrameTransformData Class Reference

#include <idl_generated_code/yarp/math/FrameTransformData.h>

+ Inheritance diagram for yarp::math::FrameTransformData:

Public Types

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

Public Member Functions

 FrameTransformData ()=default
 
 FrameTransformData (const std::string &src_frame_id, const std::string &dst_frame_id, const double timestamp, const bool isStatic, const yarp::math::Translation &translation, const yarp::math::Quaternion &rotation)
 
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

std::string src_frame_id {}
 
std::string dst_frame_id {}
 
double timestamp {0.000000}
 
bool isStatic {false}
 
yarp::math::Translation translation {}
 
yarp::math::Quaternion rotation {}
 

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 23 of file FrameTransformData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ FrameTransformData() [1/2]

yarp::math::FrameTransformData::FrameTransformData ( )
default

◆ FrameTransformData() [2/2]

yarp::math::FrameTransformData::FrameTransformData ( const std::string &  src_frame_id,
const std::string &  dst_frame_id,
const double  timestamp,
const bool  isStatic,
const yarp::math::Translation &  translation,
const yarp::math::Quaternion &  rotation 
)

Definition at line 16 of file FrameTransformData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::math::FrameTransformData::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 60 of file FrameTransformData.cpp.

◆ read() [2/2]

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

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

Definition at line 33 of file FrameTransformData.cpp.

◆ toString()

std::string yarp::math::FrameTransformData::toString ( ) const

Definition at line 113 of file FrameTransformData.cpp.

◆ write() [1/2]

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

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

Definition at line 73 of file FrameTransformData.cpp.

◆ write() [2/2]

bool yarp::math::FrameTransformData::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 100 of file FrameTransformData.cpp.

Member Data Documentation

◆ dst_frame_id

std::string yarp::math::FrameTransformData::dst_frame_id {}

Definition at line 29 of file FrameTransformData.h.

◆ isStatic

bool yarp::math::FrameTransformData::isStatic {false}

Definition at line 31 of file FrameTransformData.h.

◆ rotation

yarp::math::Quaternion yarp::math::FrameTransformData::rotation {}

Definition at line 33 of file FrameTransformData.h.

◆ src_frame_id

std::string yarp::math::FrameTransformData::src_frame_id {}

Definition at line 28 of file FrameTransformData.h.

◆ timestamp

double yarp::math::FrameTransformData::timestamp {0.000000}

Definition at line 30 of file FrameTransformData.h.

◆ translation

yarp::math::Translation yarp::math::FrameTransformData::translation {}

Definition at line 32 of file FrameTransformData.h.


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