YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Pose Class Reference

#include <messages/ISimulatedWorldMsgs/idl_generated_code/Pose.h>

+ Inheritance diagram for Pose:

Public Types

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

Public Member Functions

 Pose ()=default
 
 Pose (const double x, const double y, const double z, const double roll, const double pitch, const double yaw)
 
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 x {0.0}
 
double y {0.0}
 
double z {0.0}
 
double roll {0.0}
 
double pitch {0.0}
 
double yaw {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 17 of file Pose.h.

Member Typedef Documentation

◆ unwrapped

Definition at line 56 of file Pose.h.

Constructor & Destructor Documentation

◆ Pose() [1/2]

Pose::Pose ( )
default

◆ Pose() [2/2]

Pose::Pose ( const double  x,
const double  y,
const double  z,
const double  roll,
const double  pitch,
const double  yaw 
)

Definition at line 14 of file Pose.cpp.

Member Function Documentation

◆ read() [1/2]

bool Pose::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 58 of file Pose.cpp.

◆ read() [2/2]

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

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

Definition at line 31 of file Pose.cpp.

◆ toString()

std::string Pose::toString ( ) const

Definition at line 111 of file Pose.cpp.

◆ write() [1/2]

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

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

Definition at line 71 of file Pose.cpp.

◆ write() [2/2]

bool Pose::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 98 of file Pose.cpp.

Member Data Documentation

◆ pitch

double Pose::pitch {0.0}

Definition at line 26 of file Pose.h.

◆ roll

double Pose::roll {0.0}

Definition at line 25 of file Pose.h.

◆ x

double Pose::x {0.0}

Definition at line 22 of file Pose.h.

◆ y

double Pose::y {0.0}

Definition at line 23 of file Pose.h.

◆ yaw

double Pose::yaw {0.0}

Definition at line 27 of file Pose.h.

◆ z

double Pose::z {0.0}

Definition at line 24 of file Pose.h.


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