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

#include <yarp/rosmsg/nav_msgs/Odometry.h>

+ Inheritance diagram for yarp::rosmsg::nav_msgs::Odometry:

Public Types

typedef yarp::os::idl::BareStyle< yarp::rosmsg::nav_msgs::Odometry > rosStyle
 
typedef yarp::os::idl::BottleStyle< yarp::rosmsg::nav_msgs::Odometry > bottleStyle
 

Public Member Functions

 Odometry ()
 
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
 
std::string child_frame_id
 
yarp::rosmsg::geometry_msgs::PoseWithCovariance pose
 
yarp::rosmsg::geometry_msgs::TwistWithCovariance twist
 

Static Public Attributes

static constexpr const char * typeName = "nav_msgs/Odometry"
 
static constexpr const char * typeChecksum = "cd5e73d190d741a2f92e81eda573aca7"
 
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 38 of file Odometry.h.

Member Typedef Documentation

◆ bottleStyle

typedef yarp::os::idl::BottleStyle<yarp::rosmsg::nav_msgs::Odometry> yarp::rosmsg::nav_msgs::Odometry::bottleStyle

Definition at line 197 of file Odometry.h.

◆ rosStyle

typedef yarp::os::idl::BareStyle<yarp::rosmsg::nav_msgs::Odometry> yarp::rosmsg::nav_msgs::Odometry::rosStyle

Definition at line 196 of file Odometry.h.

Constructor & Destructor Documentation

◆ Odometry()

yarp::rosmsg::nav_msgs::Odometry::Odometry ( )
inline

Definition at line 46 of file Odometry.h.

Member Function Documentation

◆ clear()

void yarp::rosmsg::nav_msgs::Odometry::clear ( )
inline

Definition at line 54 of file Odometry.h.

◆ getType()

yarp::os::Type yarp::rosmsg::nav_msgs::Odometry::getType ( ) const
inlineoverridevirtual

Reimplemented from yarp::os::Portable.

Definition at line 299 of file Odometry.h.

◆ read()

bool yarp::rosmsg::nav_msgs::Odometry::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 128 of file Odometry.h.

◆ readBare()

bool yarp::rosmsg::nav_msgs::Odometry::readBare ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 69 of file Odometry.h.

◆ readBottle()

bool yarp::rosmsg::nav_msgs::Odometry::readBottle ( yarp::os::ConnectionReader &  connection)
inlineoverridevirtual

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

Definition at line 96 of file Odometry.h.

◆ write()

bool yarp::rosmsg::nav_msgs::Odometry::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 188 of file Odometry.h.

◆ writeBare()

bool yarp::rosmsg::nav_msgs::Odometry::writeBare ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 134 of file Odometry.h.

◆ writeBottle()

bool yarp::rosmsg::nav_msgs::Odometry::writeBottle ( yarp::os::ConnectionWriter &  connection) const
inlineoverridevirtual

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

Definition at line 158 of file Odometry.h.

Member Data Documentation

◆ child_frame_id

std::string yarp::rosmsg::nav_msgs::Odometry::child_frame_id

Definition at line 42 of file Odometry.h.

◆ header

yarp::rosmsg::std_msgs::Header yarp::rosmsg::nav_msgs::Odometry::header

Definition at line 41 of file Odometry.h.

◆ pose

yarp::rosmsg::geometry_msgs::PoseWithCovariance yarp::rosmsg::nav_msgs::Odometry::pose

Definition at line 43 of file Odometry.h.

◆ twist

yarp::rosmsg::geometry_msgs::TwistWithCovariance yarp::rosmsg::nav_msgs::Odometry::twist

Definition at line 44 of file Odometry.h.

◆ typeChecksum

constexpr const char* yarp::rosmsg::nav_msgs::Odometry::typeChecksum = "cd5e73d190d741a2f92e81eda573aca7"
staticconstexpr

Definition at line 203 of file Odometry.h.

◆ typeName

constexpr const char* yarp::rosmsg::nav_msgs::Odometry::typeName = "nav_msgs/Odometry"
staticconstexpr

Definition at line 200 of file Odometry.h.

◆ typeText

constexpr const char* yarp::rosmsg::nav_msgs::Odometry::typeText
staticconstexpr

Definition at line 206 of file Odometry.h.

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