YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::rosmsg::geometry_msgs::Pose Class Reference

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::geometry_msgs::PoserosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::geometry_msgs::PosebottleStyle
 

Public Member Functions

 Pose ()
 
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.
 
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.
 
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
 
- 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

yarp::rosmsg::geometry_msgs::Point position
 
yarp::rosmsg::geometry_msgs::Quaternion orientation
 

Static Public Attributes

static constexpr const char * typeName = "geometry_msgs/Pose"
 
static constexpr const char * typeChecksum = "e45d45a5a1ce597b249e23fb30fc871f"
 
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.
 

Detailed Description

Definition at line 30 of file Pose.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ Pose()

yarp::rosmsg::geometry_msgs::Pose::Pose ( )
inline

Definition at line 36 of file Pose.h.

Member Function Documentation

◆ clear()

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

Definition at line 42 of file Pose.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 169 of file Pose.h.

◆ read()

bool yarp::rosmsg::geometry_msgs::Pose::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 88 of file Pose.h.

◆ readBare()

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

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

Definition at line 51 of file Pose.h.

◆ readBottle()

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

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

Definition at line 66 of file Pose.h.

◆ write()

bool yarp::rosmsg::geometry_msgs::Pose::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 129 of file Pose.h.

◆ writeBare()

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

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

Definition at line 94 of file Pose.h.

◆ writeBottle()

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

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

Definition at line 109 of file Pose.h.

Member Data Documentation

◆ orientation

yarp::rosmsg::geometry_msgs::Quaternion yarp::rosmsg::geometry_msgs::Pose::orientation

Definition at line 34 of file Pose.h.

◆ position

yarp::rosmsg::geometry_msgs::Point yarp::rosmsg::geometry_msgs::Pose::position

Definition at line 33 of file Pose.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::geometry_msgs::Pose::typeChecksum = "e45d45a5a1ce597b249e23fb30fc871f"
staticconstexpr

Definition at line 144 of file Pose.h.

◆ typeName

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

Definition at line 141 of file Pose.h.

◆ typeText

constexpr const char* yarp::rosmsg::geometry_msgs::Pose::typeText
staticconstexpr
Initial value:
= "\
# A representation of pose in free space, composed of position and orientation. \n\
Point position\n\
Quaternion orientation\n\
\n\
================================================================================\n\
MSG: geometry_msgs/Point\n\
# This contains the position of a point in free space\n\
float64 x\n\
float64 y\n\
float64 z\n\
\n\
================================================================================\n\
MSG: geometry_msgs/Quaternion\n\
# 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 147 of file Pose.h.


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