Odometry2D Class Reference
[Spaces]

Velocity in 2D, linear velocity along x, y and angular velocity along z. More...

#include <Odometry2D.h>

List of all members.

Public Member Functions
	Odometry2D (Decimal xVel=0.0, Decimal yVel=0.0, Decimal zOmega=0.0)
	Complete constructor.
	Odometry2D (Position A, Decimal zOmega=0.0)
	Complete constructor.
	Odometry2D (const Odometry2D &A)
	Copy constructor.
Odometry2D &	operator= (const Odometry2D &A)
	Assignment operator.
Odometry2D &	operator+= (const Odometry2D &A)
	Operator +=.
const Odometry2D	operator+ (const Odometry2D &other) const
	Operator +.
Odometry2D &	operator*= (const Odometry2D &A)
	Operator *=.
Odometry2D &	operator*= (const Decimal &scalar)
	Operator *=.
const Odometry2D	operator* (const Odometry2D &other) const
	Operator *.
Odometry2D	operator* (const Decimal &scalar) const
	Operator *.
Odometry2D &	operator-= (const Odometry2D &A)
	Operator -=.
const Odometry2D	operator- (const Odometry2D &other) const
	Operator -.
Odometry2D &	operator/= (const Odometry2D &A)
	Operator /=.
Odometry2D &	operator/= (const Decimal &scalar)
	Operator /=.
const Odometry2D	operator/ (const Odometry2D &other) const
	Operator /.
Odometry2D	operator/ (const Decimal &scalar) const
	Operator /.
bool	operator== (const Odometry2D &other) const
	Operator ==.
bool	operator!= (const Odometry2D &other) const
	Operator !=.
Decimal	getVelX ()
	Get the linear velocity along x.
Decimal	getVelY ()
	Get the linear velocity along x.
Decimal	getOmegaZ ()
	Get the angular velocity along z.
void	setVelX (Decimal xVel)
	Set the linear velocity along x.
void	setVelY (Decimal yVel)
	Set the linear velocity along x.
void	setOmegaZ (Decimal zOmega)
	Set the angular velocity along z.
string	print ()
	Print the actual Odometry2D variable.

---

Detailed Description

Velocity in 2D, linear velocity along x, y and angular velocity along z.

Author:

Marco Cognetti

Note:

It is assumed that the velocity is set only at creation time or by copy.

---

Constructor & Destructor Documentation

Odometry2D::Odometry2D	(	Decimal	xVel = 0.0,
		Decimal	yVel = 0.0,
		Decimal	zOmega = 0.0
	)			[inline]

Complete constructor.

Odometry2D::Odometry2D	(	Position	A,
		Decimal	zOmega = 0.0
	)			[inline]

Complete constructor.

Odometry2D::Odometry2D

(

const Odometry2D &

A

)

[inline]

Copy constructor.

---

Member Function Documentation

Odometry2D& Odometry2D::operator=

(

const Odometry2D &

A

)

[inline]

Assignment operator.

Odometry2D& Odometry2D::operator+=

(

const Odometry2D &

A

)

[inline]

Operator +=.

const Odometry2D Odometry2D::operator+

(

const Odometry2D &

other

)

const [inline]

Operator +.

Odometry2D& Odometry2D::operator*=

(

const Odometry2D &

A

)

[inline]

Operator *=.

Odometry2D& Odometry2D::operator*=

(

const Decimal &

scalar

)

[inline]

Operator *=.

const Odometry2D Odometry2D::operator*

(

const Odometry2D &

other

)

const [inline]

Operator *.

Odometry2D Odometry2D::operator*

(

const Decimal &

scalar

)

const [inline]

Operator *.

Odometry2D& Odometry2D::operator-=

(

const Odometry2D &

A

)

[inline]

Operator -=.

const Odometry2D Odometry2D::operator-

(

const Odometry2D &

other

)

const [inline]

Operator -.

Odometry2D& Odometry2D::operator/=

(

const Odometry2D &

A

)

[inline]

Operator /=.

Odometry2D& Odometry2D::operator/=

(

const Decimal &

scalar

)

[inline]

Operator /=.

const Odometry2D Odometry2D::operator/

(

const Odometry2D &

other

)

const [inline]

Operator /.

Odometry2D Odometry2D::operator/

(

const Decimal &

scalar

)

const [inline]

Operator /.

bool Odometry2D::operator==

(

const Odometry2D &

other

)

const [inline]

Operator ==.

bool Odometry2D::operator!=

(

const Odometry2D &

other

)

const [inline]

Operator !=.

Decimal Odometry2D::getVelX

(

)

[inline]

Get the linear velocity along x.

Returns:

The actual linear velocity along x axis

Decimal Odometry2D::getVelY

(

)

[inline]

Get the linear velocity along x.

Returns:

The actual linear velocity along y axis

Decimal Odometry2D::getOmegaZ

(

)

[inline]

Get the angular velocity along z.

Returns:

The actual angular velocity along z axis

void Odometry2D::setVelX

(

Decimal

xVel

)

[inline]

Set the linear velocity along x.

Parameters:

[in]

xVel

Linear velocity along x to be set

void Odometry2D::setVelY

(

Decimal

yVel

)

[inline]

Set the linear velocity along x.

Parameters:

[in]

yVel

Linear velocity along y to be set

void Odometry2D::setOmegaZ

(

Decimal

zOmega

)

[inline]

Set the angular velocity along z.

Parameters:

[in]

zOmega

Angular velocity along z to be set

string Odometry2D::print

(

)

[inline]

Print the actual Odometry2D variable.

---

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

• baselib/Spaces/Odometry2D.h