YARP
Yet Another Robot Platform
yarp::dev::OdometryData Class Reference

#include <yarp/dev/OdometryData.h>

+ Inheritance diagram for yarp::dev::OdometryData:

Public Types

typedef yarp::os::idl::Unwrapped< OdometryDataunwrapped
 

Public Member Functions

 OdometryData ()=default
 
 OdometryData (const double odom_x, const double odom_y, const double odom_theta, const double base_vel_x, const double base_vel_y, const double base_vel_theta, const double odom_vel_x, const double odom_vel_y, const double odom_vel_theta)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
std::string toString () const
 
- 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
 
- Public Member Functions inherited from yarp::os::Portable
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

double odom_x {0.0}
 position of the robot [m], expressed in the world reference frame More...
 
double odom_y {0.0}
 position of the robot [m], expressed in the world reference frame More...
 
double odom_theta {0.0}
 orientation the robot [deg], expressed in the world reference frame More...
 
double base_vel_x {0.0}
 velocity of the robot [m/s] expressed in the robot reference frame More...
 
double base_vel_y {0.0}
 velocity of the robot [m/s] expressed in the robot reference frame More...
 
double base_vel_theta {0.0}
 angular velocity of the robot [deg/s] expressed in the robot reference frame More...
 
double odom_vel_x {0.0}
 velocity of the robot [m/s] expressed in the world reference frame More...
 
double odom_vel_y {0.0}
 velocity of the robot [m/s] expressed in the world reference frame More...
 
double odom_vel_theta {0.0}
 angular velocity of the robot [deg/s] expressed in the world reference frame More...
 

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 21 of file OdometryData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ OdometryData() [1/2]

yarp::dev::OdometryData::OdometryData ( )
default

◆ OdometryData() [2/2]

yarp::dev::OdometryData::OdometryData ( const double  odom_x,
const double  odom_y,
const double  odom_theta,
const double  base_vel_x,
const double  base_vel_y,
const double  base_vel_theta,
const double  odom_vel_x,
const double  odom_vel_y,
const double  odom_vel_theta 
)

Definition at line 16 of file OdometryData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::OdometryData::read ( yarp::os::ConnectionReader reader)
overridevirtual

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 75 of file OdometryData.cpp.

◆ read() [2/2]

bool yarp::dev::OdometryData::read ( yarp::os::idl::WireReader reader)
overridevirtual

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

Definition at line 39 of file OdometryData.cpp.

◆ toString()

std::string yarp::dev::OdometryData::toString ( ) const

Definition at line 137 of file OdometryData.cpp.

◆ write() [1/2]

bool yarp::dev::OdometryData::write ( const yarp::os::idl::WireWriter writer) const
overridevirtual

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

Definition at line 88 of file OdometryData.cpp.

◆ write() [2/2]

bool yarp::dev::OdometryData::write ( yarp::os::ConnectionWriter writer) const
overridevirtual

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 124 of file OdometryData.cpp.

Member Data Documentation

◆ base_vel_theta

double yarp::dev::OdometryData::base_vel_theta {0.0}

angular velocity of the robot [deg/s] expressed in the robot reference frame

Definition at line 49 of file OdometryData.h.

◆ base_vel_x

double yarp::dev::OdometryData::base_vel_x {0.0}

velocity of the robot [m/s] expressed in the robot reference frame

Definition at line 41 of file OdometryData.h.

◆ base_vel_y

double yarp::dev::OdometryData::base_vel_y {0.0}

velocity of the robot [m/s] expressed in the robot reference frame

Definition at line 45 of file OdometryData.h.

◆ odom_theta

double yarp::dev::OdometryData::odom_theta {0.0}

orientation the robot [deg], expressed in the world reference frame

Definition at line 37 of file OdometryData.h.

◆ odom_vel_theta

double yarp::dev::OdometryData::odom_vel_theta {0.0}

angular velocity of the robot [deg/s] expressed in the world reference frame

Definition at line 61 of file OdometryData.h.

◆ odom_vel_x

double yarp::dev::OdometryData::odom_vel_x {0.0}

velocity of the robot [m/s] expressed in the world reference frame

Definition at line 53 of file OdometryData.h.

◆ odom_vel_y

double yarp::dev::OdometryData::odom_vel_y {0.0}

velocity of the robot [m/s] expressed in the world reference frame

Definition at line 57 of file OdometryData.h.

◆ odom_x

double yarp::dev::OdometryData::odom_x {0.0}

position of the robot [m], expressed in the world reference frame

Definition at line 29 of file OdometryData.h.

◆ odom_y

double yarp::dev::OdometryData::odom_y {0.0}

position of the robot [m], expressed in the world reference frame

Definition at line 33 of file OdometryData.h.


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