MipResources::RangeSensPar Class Reference
[Range sensor]

parameters of an Abstract Range-sensor More...

#include <RangeSens.h>

Inheritance diagram for MipResources::RangeSensPar:

List of all members.

Public Member Functions
	RangeSensPar ()
	Default constructor.
	RangeSensPar (const RangeSensPar &s)
	Copy constructor.
RangeSensPar &	operator= (const RangeSensPar &s)
	Assigment operator =.
Decimal	linRangeMax ()
	Get Maximum Linear Range.
Decimal	linRangeMin ()
	Get Minimum Linear Range.
Decimal	linRes ()
	Get Linear Resolution.
Angle	angRangeMax ()
	Get Maximum Angular Range.
Angle	angRangeMin ()
	Get Minimum Angular Range.
Angle	angRes ()
	Get Angular Resolution.
int	numRays ()
	Get Number of Rays.
Decimal	rate ()
	Get Scan Rate.
Pose	pose ()
	Get Sensor Pose respect to the robot.
string	name ()
	Get the name.
string	print ()
	Print function.
Protected Member Functions
void	setLinRangeMin (Decimal value)
	Sets Minumum Linear Range.
void	setLinRangeMax (Decimal value)
	Sets Maximum Linear Range.
void	setLinRes (Decimal value)
	Sets Linear Resolution.
void	setAngRangeMax (Angle value)
	Sets Maximum Angular Range.
void	setAngRangeMin (Angle value)
	Sets Minimum Angular Range.
void	setAngRes (Angle value)
	Sets Angular Resolution.
void	setNumRays (uint32_t value)
	Sets the NumRays of a scan.
void	setRate (Decimal value)
	Sets the Scan Rate.
void	setPose (Pose value)
	Sets Sensor Pose respect to the robot.
void	setName (string value)
	Sets the name.

---

Detailed Description

parameters of an Abstract Range-sensor

Author:

Antonio Franchi

Note:

This class is included only in RangeSens

Writing: Theese Parameters must be setted only by means an implementation inherited parameter class (e.g, PlayerRangeSensPar), at the moment of his construction, using the RangeSensPar protected methods.

Reading: Theese Parameters can be read by the user (e.g, a MobileRob) by mean the call of the public methods of RangeSensPar from the pointer returned by the public method RangeSensPar par() of class RangeSens

---

Constructor & Destructor Documentation

MipResources::RangeSensPar::RangeSensPar

(

)

Default constructor.

MipResources::RangeSensPar::RangeSensPar

(

const RangeSensPar &

s

)

Copy constructor.

---

Member Function Documentation

void MipResources::RangeSensPar::setLinRangeMin

(

Decimal

value

)

[protected]

Sets Minumum Linear Range.

Note:

To be called before all.

void MipResources::RangeSensPar::setLinRangeMax

(

Decimal

value

)

[protected]

Sets Maximum Linear Range.

Note:

To be called after setLinRangeMin.

void MipResources::RangeSensPar::setLinRes

(

Decimal

value

)

[protected]

Sets Linear Resolution.

Note:

To be called after setLinRangeMax

void MipResources::RangeSensPar::setAngRangeMax

(

Angle

value

)

[protected]

Sets Maximum Angular Range.

Note:

To be called after ...

void MipResources::RangeSensPar::setAngRangeMin

(

Angle

value

)

[protected]

Sets Minimum Angular Range.

Note:

To be called after ...

void MipResources::RangeSensPar::setAngRes

(

Angle

value

)

[protected]

Sets Angular Resolution.

Note:

To be called after ...

void MipResources::RangeSensPar::setNumRays

(

uint32_t

value

)

[protected]

Sets the NumRays of a scan.

Note:

To be called after ...

void MipResources::RangeSensPar::setRate

(

Decimal

value

)

[protected]

Sets the Scan Rate.

Note:

To be called after ...

void MipResources::RangeSensPar::setPose

(

Pose

value

)

[protected]

Sets Sensor Pose respect to the robot.

void MipResources::RangeSensPar::setName

(

string

value

)

[protected]

Sets the name.

RangeSensPar & MipResources::RangeSensPar::operator=

(

const RangeSensPar &

s

)

Assigment operator =.

Decimal MipResources::RangeSensPar::linRangeMax

(

)

Get Maximum Linear Range.

Decimal MipResources::RangeSensPar::linRangeMin

(

)

Get Minimum Linear Range.

Decimal MipResources::RangeSensPar::linRes

(

)

Get Linear Resolution.

Angle MipResources::RangeSensPar::angRangeMax

(

)

Get Maximum Angular Range.

Angle MipResources::RangeSensPar::angRangeMin

(

)

Get Minimum Angular Range.

Angle MipResources::RangeSensPar::angRes

(

)

Get Angular Resolution.

int MipResources::RangeSensPar::numRays

(

)

Get Number of Rays.

Decimal MipResources::RangeSensPar::rate

(

)

Get Scan Rate.

Pose MipResources::RangeSensPar::pose

(

void

)

Get Sensor Pose respect to the robot.

string MipResources::RangeSensPar::name

(

)

Get the name.

string MipResources::RangeSensPar::print

(

)

[inline]

Print function.

Returns:

A printable string with the value printed on it.

---

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

• resources/RangeSens/RangeSens.h
• resources/RangeSens/RangeSens.cpp