YARP
Yet Another Robot Platform
yarp::rosmsg::geometry_msgs::Quaternion Class Reference

#include <yarp/rosmsg/geometry_msgs/Quaternion.h>

+ Inheritance diagram for yarp::rosmsg::geometry_msgs::Quaternion:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::geometry_msgs::QuaternionrosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::geometry_msgs::QuaternionbottleStyle
 

Public Member Functions

 Quaternion ()
 
void clear ()
 
bool readBare (yarp::os::ConnectionReader &connection) override
 
bool readBottle (yarp::os::ConnectionReader &connection) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool writeBare (yarp::os::ConnectionWriter &connection) const override
 
bool writeBottle (yarp::os::ConnectionWriter &connection) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
yarp::os::Type getType () const override
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
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
 
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. 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
 

Public Attributes

yarp::conf::float64_t x
 
yarp::conf::float64_t y
 
yarp::conf::float64_t z
 
yarp::conf::float64_t w
 

Static Public Attributes

static constexpr const char * typeName = "geometry_msgs/Quaternion"
 
static constexpr const char * typeChecksum = "a779879fadf0160734f906b8c19c7004"
 
static constexpr const char * typeText
 

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. More...
 

Detailed Description

Definition at line 31 of file Quaternion.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ Quaternion()

yarp::rosmsg::geometry_msgs::Quaternion::Quaternion ( )
inline

Definition at line 39 of file Quaternion.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::geometry_msgs::Quaternion::clear ( )
inline

Definition at line 47 of file Quaternion.h.

◆ getType()

yarp::os::Type yarp::rosmsg::geometry_msgs::Quaternion::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 179 of file Quaternion.h.

◆ read()

bool yarp::rosmsg::geometry_msgs::Quaternion::read ( yarp::os::ConnectionReader reader)
inlineoverridevirtual

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 103 of file Quaternion.h.

◆ readBare()

bool yarp::rosmsg::geometry_msgs::Quaternion::readBare ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 62 of file Quaternion.h.

◆ readBottle()

bool yarp::rosmsg::geometry_msgs::Quaternion::readBottle ( yarp::os::ConnectionReader connection)
inlineoverridevirtual

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

Definition at line 79 of file Quaternion.h.

◆ write()

bool yarp::rosmsg::geometry_msgs::Quaternion::write ( yarp::os::ConnectionWriter writer) const
inlineoverridevirtual

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 152 of file Quaternion.h.

◆ writeBare()

bool yarp::rosmsg::geometry_msgs::Quaternion::writeBare ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 109 of file Quaternion.h.

◆ writeBottle()

bool yarp::rosmsg::geometry_msgs::Quaternion::writeBottle ( yarp::os::ConnectionWriter connection) const
inlineoverridevirtual

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

Definition at line 126 of file Quaternion.h.

Member Data Documentation

◆ typeChecksum

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeChecksum = "a779879fadf0160734f906b8c19c7004"
staticconstexpr

Definition at line 167 of file Quaternion.h.

◆ typeName

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeName = "geometry_msgs/Quaternion"
staticconstexpr

Definition at line 164 of file Quaternion.h.

◆ typeText

constexpr const char* yarp::rosmsg::geometry_msgs::Quaternion::typeText
staticconstexpr
Initial value:
= "\
# This represents an orientation in free space in quaternion form.\n\
\n\
float64 x\n\
float64 y\n\
float64 z\n\
float64 w\n\
"

Definition at line 170 of file Quaternion.h.

◆ w

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::w

Definition at line 37 of file Quaternion.h.

◆ x

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::x

Definition at line 34 of file Quaternion.h.

◆ y

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::y

Definition at line 35 of file Quaternion.h.

◆ z

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Quaternion::z

Definition at line 36 of file Quaternion.h.


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