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

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::geometry_msgs::PointStampedrosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::geometry_msgs::PointStampedbottleStyle
 

Public Member Functions

 PointStamped ()
 
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
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. 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::rosmsg::std_msgs::Header header
 
yarp::rosmsg::geometry_msgs::Point point
 

Static Public Attributes

static constexpr const char * typeName = "geometry_msgs/PointStamped"
 
static constexpr const char * typeChecksum = "c63aecb41bfdfd6b7e1fac37c7cbe7bf"
 
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 30 of file PointStamped.h.

Member Typedef Documentation

◆ bottleStyle

◆ rosStyle

Constructor & Destructor Documentation

◆ PointStamped()

yarp::rosmsg::geometry_msgs::PointStamped::PointStamped ( )
inline

Definition at line 36 of file PointStamped.h.

Member Function Documentation

◆ clear()

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

Definition at line 42 of file PointStamped.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 178 of file PointStamped.h.

◆ read()

bool yarp::rosmsg::geometry_msgs::PointStamped::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 PointStamped.h.

◆ readBare()

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

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

Definition at line 51 of file PointStamped.h.

◆ readBottle()

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

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

Definition at line 66 of file PointStamped.h.

◆ write()

bool yarp::rosmsg::geometry_msgs::PointStamped::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 PointStamped.h.

◆ writeBare()

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

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

Definition at line 94 of file PointStamped.h.

◆ writeBottle()

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

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

Definition at line 109 of file PointStamped.h.

Member Data Documentation

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::geometry_msgs::PointStamped::header

Definition at line 33 of file PointStamped.h.

◆ point

yarp::rosmsg::geometry_msgs::Point yarp::rosmsg::geometry_msgs::PointStamped::point

Definition at line 34 of file PointStamped.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::geometry_msgs::PointStamped::typeChecksum = "c63aecb41bfdfd6b7e1fac37c7cbe7bf"
staticconstexpr

Definition at line 144 of file PointStamped.h.

◆ typeName

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

Definition at line 141 of file PointStamped.h.

◆ typeText

constexpr const char* yarp::rosmsg::geometry_msgs::PointStamped::typeText
staticconstexpr
Initial value:
= "\
# This represents a Point with reference coordinate frame and timestamp\n\
Header header\n\
Point point\n\
\n\
================================================================================\n\
MSG: std_msgs/Header\n\
# Standard metadata for higher-level stamped data types.\n\
# This is generally used to communicate timestamped data \n\
# in a particular coordinate frame.\n\
# \n\
# sequence ID: consecutively increasing ID \n\
uint32 seq\n\
#Two-integer timestamp that is expressed as:\n\
# * stamp.sec: seconds (stamp_secs) since epoch (in Python the variable is called 'secs')\n\
# * stamp.nsec: nanoseconds since stamp_secs (in Python the variable is called 'nsecs')\n\
# time-handling sugar is provided by the client library\n\
time stamp\n\
#Frame this data is associated with\n\
# 0: no frame\n\
# 1: global frame\n\
string frame_id\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\
"

Definition at line 147 of file PointStamped.h.


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