MipBaselib::Odometry2DArma Class Reference

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

#include <R2Arma.h>

List of all members.

Public Member Functions
	Odometry2DArma ()
	Default constructor.
	Odometry2DArma (const Decimal &xVel, const Decimal &yVel, const Decimal &zOmega)
	Complete constructor.
	Odometry2DArma (const Position2DArma &A, const Decimal &zOmega)
	Complete constructor.
	Odometry2DArma (const Odometry2DArma &A)
	Copy constructor.
Odometry2DArma &	operator= (const Odometry2DArma &rhs)
	Assignment operator.
Odometry2DArma &	operator= (const arma::Mat< Decimal > &rhs)
	Assignment operator.
Odometry2DArma &	operator+= (const Odometry2DArma &A)
	Operator +=.
Odometry2DArma &	operator+= (const Decimal &scalar)
	Compound assignment operator sum by a scalar +.
Odometry2DArma	operator+ (Odometry2DArma &other) const
	Operator +.
Odometry2DArma &	operator-= (const Odometry2DArma &A)
	Operator +=.
Odometry2DArma &	operator-= (const Decimal &scalar)
	Compound assignment operator sum by a scalar +.
Odometry2DArma	operator- (Odometry2DArma &other) const
	Operator +.
Odometry2DArma &	operator*= (const Odometry2DArma &A)
	Operator *=.
Odometry2DArma &	operator*= (const Decimal &scalar)
	Compound assignment operator multiplied by a scalar.
Odometry2DArma	operator* (Odometry2DArma &other) const
	Operator *.
Odometry2DArma &	operator/= (const Odometry2DArma &A)
	Operator /=.
Odometry2DArma &	operator/= (const Decimal &scalar)
	Compound assignment operator dividied by a scalar.
Odometry2DArma	operator/ (Odometry2DArma &other) const
	Operator /.
bool	operator== (const Odometry2DArma &other) const
	Operator ==.
bool	operator!= (const Odometry2DArma &other) const
	Operator !=.
Decimal	getVelX () const
	Get the linear velocity along x.
Decimal	getVelY () const
	Get the linear velocity along y.
Decimal	getOmegaZ () const
	Get the angular velocity along z.
Velocity2DArma	getVelocity () const
	Get the angular velocity.
void	setVelX (const Decimal &xVel)
	Set the linear velocity along x.
void	setVelY (const Decimal &yVel)
	Set the linear velocity along y.
void	setVelocity (const Velocity2DArma &vel)
	Set the linear velocity.
void	setOmegaZ (const Decimal &zOmega)
	Set the angular velocity along z.
string	print ()
	Print the actual Odometry2DArma variable.

---

Detailed Description

Odometry 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

Odometry2DArma::Odometry2DArma

(

)

Default constructor.

Odometry2DArma::Odometry2DArma	(	const Decimal &	xVel,
		const Decimal &	yVel,
		const Decimal &	zOmega
	)

Complete constructor.

Odometry2DArma::Odometry2DArma	(	const Position2DArma &	A,
		const Decimal &	zOmega
	)

Complete constructor.

Odometry2DArma::Odometry2DArma

(

const Odometry2DArma &

A

)

Copy constructor.

---

Member Function Documentation

Odometry2DArma & Odometry2DArma::operator=

(

const Odometry2DArma &

rhs

)

Assignment operator.

Odometry2DArma & Odometry2DArma::operator=

(

const arma::Mat< Decimal > &

rhs

)

Assignment operator.

Odometry2DArma & Odometry2DArma::operator+=

(

const Odometry2DArma &

A

)

Operator +=.

Odometry2DArma & Odometry2DArma::operator+=

(

const Decimal &

scalar

)

Compound assignment operator sum by a scalar +.

Odometry2DArma Odometry2DArma::operator+

(

Odometry2DArma &

other

)

const

Operator +.

Odometry2DArma & Odometry2DArma::operator-=

(

const Odometry2DArma &

A

)

Operator +=.

Odometry2DArma & Odometry2DArma::operator-=

(

const Decimal &

scalar

)

Compound assignment operator sum by a scalar +.

Odometry2DArma Odometry2DArma::operator-

(

Odometry2DArma &

other

)

const

Operator +.

Odometry2DArma & Odometry2DArma::operator*=

(

const Odometry2DArma &

A

)

Operator *=.

Odometry2DArma & Odometry2DArma::operator*=

(

const Decimal &

scalar

)

Compound assignment operator multiplied by a scalar.

Odometry2DArma Odometry2DArma::operator*

(

Odometry2DArma &

other

)

const

Operator *.

Odometry2DArma & Odometry2DArma::operator/=

(

const Odometry2DArma &

A

)

Operator /=.

Odometry2DArma & Odometry2DArma::operator/=

(

const Decimal &

scalar

)

Compound assignment operator dividied by a scalar.

Odometry2DArma Odometry2DArma::operator/

(

Odometry2DArma &

other

)

const

Operator /.

bool Odometry2DArma::operator==

(

const Odometry2DArma &

other

)

const

Operator ==.

bool Odometry2DArma::operator!=

(

const Odometry2DArma &

other

)

const

Operator !=.

Decimal Odometry2DArma::getVelX

(

)

const

Get the linear velocity along x.

Returns:

The actual linear velocity along x axis

Decimal Odometry2DArma::getVelY

(

)

const

Get the linear velocity along y.

Returns:

The actual linear velocity along y axis

Decimal Odometry2DArma::getOmegaZ

(

)

const

Get the angular velocity along z.

Returns:

The actual angular velocity along z axis

Velocity2DArma Odometry2DArma::getVelocity

(

)

const

Get the angular velocity.

Returns:

The actual angular velocity

void Odometry2DArma::setVelX

(

const Decimal &

xVel

)

Set the linear velocity along x.

Parameters:

[in]

xVel

Linear velocity along x to be set

void Odometry2DArma::setVelY

(

const Decimal &

yVel

)

Set the linear velocity along y.

Parameters:

[in]

yVel

Linear velocity along y to be set

void Odometry2DArma::setVelocity

(

const Velocity2DArma &

vel

)

Set the linear velocity.

Parameters:

[in]

yVel

Linear velocity

void Odometry2DArma::setOmegaZ

(

const Decimal &

zOmega

)

Set the angular velocity along z.

Parameters:

[in]

zOmega

Angular velocity along z to be set

string Odometry2DArma::print

(

)

Print the actual Odometry2DArma variable.

---

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

• baselib/Spaces/R2Arma.h
• baselib/Spaces/R2Arma.cpp