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

#include <yarp/dev/OdometryData6D.h>

+ Inheritance diagram for yarp::dev::OdometryData6D:

Classes

class  Editor
 

Public Types

typedef yarp::os::idl::Unwrapped< OdometryData6Dunwrapped
 

Public Member Functions

 OdometryData6D ()
 
 OdometryData6D (const double odom_x, const double odom_y, const double odom_z, const double odom_roll, const double odom_pitch, const double odom_yaw, const double base_vel_x, const double base_vel_y, const double base_vel_z, const double base_vel_roll, const double base_vel_pitch, const double base_vel_yaw, const double odom_vel_x, const double odom_vel_y, const double odom_vel_z, const double odom_vel_roll, const double odom_vel_pitch, const double odom_vel_yaw)
 
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 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
virtual Type getType () 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

double odom_x
 position of the robot [m], expressed in the world reference frame More...
 
double odom_y
 position of the robot [m], expressed in the world reference frame More...
 
double odom_z
 position of the robot [m], expressed in the world reference frame More...
 
double odom_roll
 orientation the robot [deg], expressed in the world reference frame More...
 
double odom_pitch
 orientation the robot [deg], expressed in the world reference frame More...
 
double odom_yaw
 orientation the robot [deg], expressed in the world reference frame More...
 
double base_vel_x
 velocity of the robot [m/s] expressed in the robot reference frame More...
 
double base_vel_y
 velocity of the robot [m/s] expressed in the robot reference frame More...
 
double base_vel_z
 velocity of the robot [m/s] expressed in the robot reference frame More...
 
double base_vel_roll
 angular velocity of the robot [deg/s] expressed in the robot reference frame More...
 
double base_vel_pitch
 angular velocity of the robot [deg/s] expressed in the robot reference frame More...
 
double base_vel_yaw
 angular velocity of the robot [deg/s] expressed in the robot reference frame More...
 
double odom_vel_x
 velocity of the robot [m/s] expressed in the world reference frame More...
 
double odom_vel_y
 velocity of the robot [m/s] expressed in the world reference frame More...
 
double odom_vel_z
 velocity of the robot [m/s] expressed in the world reference frame More...
 
double odom_vel_roll
 angular velocity of the robot [deg/s] expressed in the world reference frame More...
 
double odom_vel_pitch
 angular velocity of the robot [deg/s] expressed in the world reference frame More...
 
double odom_vel_yaw
 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 25 of file OdometryData6D.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ OdometryData6D() [1/2]

yarp::dev::OdometryData6D::OdometryData6D ( )

Definition at line 20 of file OdometryData6D.cpp.

◆ OdometryData6D() [2/2]

yarp::dev::OdometryData6D::OdometryData6D ( const double  odom_x,
const double  odom_y,
const double  odom_z,
const double  odom_roll,
const double  odom_pitch,
const double  odom_yaw,
const double  base_vel_x,
const double  base_vel_y,
const double  base_vel_z,
const double  base_vel_roll,
const double  base_vel_pitch,
const double  base_vel_yaw,
const double  odom_vel_x,
const double  odom_vel_y,
const double  odom_vel_z,
const double  odom_vel_roll,
const double  odom_vel_pitch,
const double  odom_vel_yaw 
)

Definition at line 44 of file OdometryData6D.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::OdometryData6D::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 145 of file OdometryData6D.cpp.

◆ read() [2/2]

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

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

Definition at line 85 of file OdometryData6D.cpp.

◆ toString()

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

Definition at line 225 of file OdometryData6D.cpp.

◆ write() [1/2]

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

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

Definition at line 155 of file OdometryData6D.cpp.

◆ write() [2/2]

bool yarp::dev::OdometryData6D::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 215 of file OdometryData6D.cpp.

Member Data Documentation

◆ base_vel_pitch

double yarp::dev::OdometryData6D::base_vel_pitch

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

Definition at line 73 of file OdometryData6D.h.

◆ base_vel_roll

double yarp::dev::OdometryData6D::base_vel_roll

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

Definition at line 69 of file OdometryData6D.h.

◆ base_vel_x

double yarp::dev::OdometryData6D::base_vel_x

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

Definition at line 57 of file OdometryData6D.h.

◆ base_vel_y

double yarp::dev::OdometryData6D::base_vel_y

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

Definition at line 61 of file OdometryData6D.h.

◆ base_vel_yaw

double yarp::dev::OdometryData6D::base_vel_yaw

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

Definition at line 77 of file OdometryData6D.h.

◆ base_vel_z

double yarp::dev::OdometryData6D::base_vel_z

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

Definition at line 65 of file OdometryData6D.h.

◆ odom_pitch

double yarp::dev::OdometryData6D::odom_pitch

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

Definition at line 49 of file OdometryData6D.h.

◆ odom_roll

double yarp::dev::OdometryData6D::odom_roll

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

Definition at line 45 of file OdometryData6D.h.

◆ odom_vel_pitch

double yarp::dev::OdometryData6D::odom_vel_pitch

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

Definition at line 97 of file OdometryData6D.h.

◆ odom_vel_roll

double yarp::dev::OdometryData6D::odom_vel_roll

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

Definition at line 93 of file OdometryData6D.h.

◆ odom_vel_x

double yarp::dev::OdometryData6D::odom_vel_x

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

Definition at line 81 of file OdometryData6D.h.

◆ odom_vel_y

double yarp::dev::OdometryData6D::odom_vel_y

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

Definition at line 85 of file OdometryData6D.h.

◆ odom_vel_yaw

double yarp::dev::OdometryData6D::odom_vel_yaw

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

Definition at line 101 of file OdometryData6D.h.

◆ odom_vel_z

double yarp::dev::OdometryData6D::odom_vel_z

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

Definition at line 89 of file OdometryData6D.h.

◆ odom_x

double yarp::dev::OdometryData6D::odom_x

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

Definition at line 33 of file OdometryData6D.h.

◆ odom_y

double yarp::dev::OdometryData6D::odom_y

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

Definition at line 37 of file OdometryData6D.h.

◆ odom_yaw

double yarp::dev::OdometryData6D::odom_yaw

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

Definition at line 53 of file OdometryData6D.h.

◆ odom_z

double yarp::dev::OdometryData6D::odom_z

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

Definition at line 41 of file OdometryData6D.h.


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