YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
yarp::rosmsg::geometry_msgs::Vector3 Class Reference

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

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

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::geometry_msgs::Vector3 > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::geometry_msgs::Vector3 > bottleStyle
 

Public Member Functions

 Vector3 ()
 
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::conf::float64_t x
 
yarp::conf::float64_t y
 
yarp::conf::float64_t z
 

Static Public Attributes

static constexpr const char * typeName = "geometry_msgs/Vector3"
 
static constexpr const char * typeChecksum = "4a842b65f413084dc2b10fb484ea7f17"
 
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 37 of file Vector3.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::geometry_msgs::Vector3> yarp::rosmsg::geometry_msgs::Vector3::bottleStyle

Definition at line 149 of file Vector3.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::geometry_msgs::Vector3> yarp::rosmsg::geometry_msgs::Vector3::rosStyle

Definition at line 148 of file Vector3.h.

Constructor & Destructor Documentation

◆ Vector3()

yarp::rosmsg::geometry_msgs::Vector3::Vector3 ( )
inline

Definition at line 44 of file Vector3.h.

Member Function Documentation

◆ clear()

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

Definition at line 51 of file Vector3.h.

◆ getType()

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

Reimplemented from yarp::os::Portable.

Definition at line 171 of file Vector3.h.

◆ read()

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

◆ readBare()

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

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

Definition at line 63 of file Vector3.h.

◆ readBottle()

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

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

Definition at line 77 of file Vector3.h.

◆ write()

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

◆ writeBare()

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

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

Definition at line 104 of file Vector3.h.

◆ writeBottle()

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

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

Definition at line 118 of file Vector3.h.

Member Data Documentation

◆ typeChecksum

constexpr const char* yarp::rosmsg::geometry_msgs::Vector3::typeChecksum = "4a842b65f413084dc2b10fb484ea7f17"
staticconstexpr

Definition at line 155 of file Vector3.h.

◆ typeName

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

Definition at line 152 of file Vector3.h.

◆ typeText

constexpr const char* yarp::rosmsg::geometry_msgs::Vector3::typeText
staticconstexpr
Initial value:
= "\
# This represents a vector in free space. \n\
# It is only meant to represent a direction. Therefore, it does not\n\
# make sense to apply a translation to it (e.g., when applying a \n\
# generic rigid transformation to a Vector3, tf2 will only apply the\n\
# rotation). If you want your data to be translatable too, use the\n\
# geometry_msgs/Point message instead.\n\
\n\
float64 x\n\
float64 y\n\
float64 z\n\
"

Definition at line 158 of file Vector3.h.

◆ x

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Vector3::x

Definition at line 40 of file Vector3.h.

◆ y

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Vector3::y

Definition at line 41 of file Vector3.h.

◆ z

yarp::conf::float64_t yarp::rosmsg::geometry_msgs::Vector3::z

Definition at line 42 of file Vector3.h.

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