YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::sig::QuaternionData Class Reference

#include <idl_generated_code/yarp/sig/QuaternionData.h>

+ Inheritance diagram for yarp::sig::QuaternionData:

Public Types

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

Public Member Functions

 QuaternionData ()=default
 
 QuaternionData (const double q_w, const double q_x, const double q_y, const double q_z)
 
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

double q_w {0.0}
 
double q_x {0.0}
 
double q_y {0.0}
 
double q_z {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

Definition at line 21 of file QuaternionData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ QuaternionData() [1/2]

yarp::sig::QuaternionData::QuaternionData ( )
default

◆ QuaternionData() [2/2]

yarp::sig::QuaternionData::QuaternionData ( const double  q_w,
const double  q_x,
const double  q_y,
const double  q_z 
)

Definition at line 16 of file QuaternionData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::sig::QuaternionData::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 50 of file QuaternionData.cpp.

◆ read() [2/2]

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

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

Definition at line 29 of file QuaternionData.cpp.

◆ toString()

std::string yarp::sig::QuaternionData::toString ( ) const

Definition at line 97 of file QuaternionData.cpp.

◆ write() [1/2]

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

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

Definition at line 63 of file QuaternionData.cpp.

◆ write() [2/2]

bool yarp::sig::QuaternionData::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 84 of file QuaternionData.cpp.

Member Data Documentation

◆ q_w

double yarp::sig::QuaternionData::q_w {0.0}

Definition at line 26 of file QuaternionData.h.

◆ q_x

double yarp::sig::QuaternionData::q_x {0.0}

Definition at line 27 of file QuaternionData.h.

◆ q_y

double yarp::sig::QuaternionData::q_y {0.0}

Definition at line 28 of file QuaternionData.h.

◆ q_z

double yarp::sig::QuaternionData::q_z {0.0}

Definition at line 29 of file QuaternionData.h.


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