yarp::dev::Nav2D::IOdometry2D Class Reference

IOdometry2D interface. More...

#include <yarp/dev/IOdometry2D.h>

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

Public Member Functions
virtual	~IOdometry2D ()
	Destructor.
virtual yarp::dev::ReturnValue	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.
virtual yarp::dev::ReturnValue	resetOdometry ()=0
	Resets the odometry of the robot to zero.

Detailed Description

IOdometry2D interface.

Provides methods to obtain the odometry data from a robot.

Definition at line 22 of file IOdometry2D.h.

Constructor & Destructor Documentation

~IOdometry2D()

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

virtualdefault

Destructor.

Member Function Documentation

getOdometry()

virtual yarp::dev::ReturnValue 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

odom	the odometry.

Returns

a ReturnValue, convertible to true/false

Implemented in FakeOdometry2D, and Odometry2D_nwc_yarp.

resetOdometry()

virtual yarp::dev::ReturnValue yarp::dev::Nav2D::IOdometry2D::resetOdometry ( )

pure virtual

Resets the odometry of the robot to zero.

Returns

a ReturnValue, convertible to true/false

Implemented in FakeOdometry2D, and Odometry2D_nwc_yarp.

---

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

• src/libYARP_dev/src/yarp/dev/IOdometry2D.h
• src/libYARP_dev/src/yarp/dev/IOdometry2D.cpp