YARP
Yet Another Robot Platform
yarp::dev::Nav2D::IOdometry2D Class Referenceabstract

IOdometry2D interface. More...

#include <yarp/dev/IOdometry2D.h>

+ Inheritance diagram for yarp::dev::Nav2D::IOdometry2D:

Public Member Functions

virtual ~IOdometry2D ()
 Destructor. More...
 
virtual bool getOdometry (yarp::dev::OdometryData &odom, double *timestamp=nullptr)=0
 Gets the odometry of the robot, including its velocity expressed in the world and in the local reference frame. More...
 
virtual bool resetOdometry ()=0
 Resets the odometry of the robot to zero. More...
 

Detailed Description

IOdometry2D interface.

Provides methods to obtain the odometry data from a robot.

Definition at line 21 of file IOdometry2D.h.

Constructor & Destructor Documentation

◆ ~IOdometry2D()

yarp::dev::Nav2D::IOdometry2D::~IOdometry2D ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getOdometry()

virtual bool yarp::dev::Nav2D::IOdometry2D::getOdometry ( yarp::dev::OdometryData odom,
double *  timestamp = nullptr 
)
pure virtual

Gets the odometry of the robot, including its velocity expressed in the world and in the local reference frame.

Parameters
odomthe odometry.
Returns
true/false

Implemented in FakeOdometry.

◆ resetOdometry()

virtual bool yarp::dev::Nav2D::IOdometry2D::resetOdometry ( )
pure virtual

Resets the odometry of the robot to zero.

Returns
true/false

Implemented in FakeOdometry.


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