MipResources::RangeSensmmPar Class Reference
[Range sensor]

parameters of an Abstract Range-sensor More...

#include <RangeSens.h>

Inheritance diagram for MipResources::RangeSensmmPar:

List of all members.

Public Member Functions
	RangeSensmmPar ()
	Default constructor.
	RangeSensmmPar (const RangeSensmmPar &s)
	Copy constructor.
RangeSensmmPar &	operator= (const RangeSensmmPar &s)
	Assigment operator =.
UCoordmm	linRangeMax ()
	Get Maximum Linear Range.
UCoordmm	linRangeMin ()
	Get Minimum Linear Range.
UCoordmm	linRes ()
	Get Linear Resolution.
Anglem	angRangeMax ()
	Get Maximum Angular Range.
Anglem	angRangeMin ()
	Get Minimum Angular Range.
Anglem	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 (UCoordmm value)
	Sets Minumum Linear Range.
void	setLinRangeMax (UCoordmm value)
	Sets Maximum Linear Range.
void	setLinRes (UCoordmm value)
	Sets Linear Resolution.
void	setAngRangeMax (Anglem value)
	Sets Maximum Angular Range.
void	setAngRangeMin (Anglem value)
	Sets Minimum Angular Range.
void	setAngRes (Anglem 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 and Paolo Stegagno

Note:

This class is included only in RangeSens

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

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

---

Constructor & Destructor Documentation

MipResources::RangeSensmmPar::RangeSensmmPar

(

)

Default constructor.

MipResources::RangeSensmmPar::RangeSensmmPar

(

const RangeSensmmPar &

s

)

Copy constructor.

---

Member Function Documentation

void MipResources::RangeSensmmPar::setLinRangeMin

(

UCoordmm

value

)

[protected]

Sets Minumum Linear Range.

Note:

To be called before all.

void MipResources::RangeSensmmPar::setLinRangeMax

(

UCoordmm

value

)

[protected]

Sets Maximum Linear Range.

Note:

To be called after setLinRangeMin.

void MipResources::RangeSensmmPar::setLinRes

(

UCoordmm

value

)

[protected]

Sets Linear Resolution.

Note:

To be called after setLinRangeMax

void MipResources::RangeSensmmPar::setAngRangeMax

(

Anglem

value

)

[protected]

Sets Maximum Angular Range.

Note:

To be called after ...

void MipResources::RangeSensmmPar::setAngRangeMin

(

Anglem

value

)

[protected]

Sets Minimum Angular Range.

Note:

To be called after ...

void MipResources::RangeSensmmPar::setAngRes

(

Anglem

value

)

[protected]

Sets Angular Resolution.

Note:

To be called after ...

void MipResources::RangeSensmmPar::setNumRays

(

uint32_t

value

)

[protected]

Sets the NumRays of a scan.

Note:

To be called after ...

void MipResources::RangeSensmmPar::setRate

(

Decimal

value

)

[protected]

Sets the Scan Rate.

Note:

To be called after ...

void MipResources::RangeSensmmPar::setPose

(

Pose

value

)

[protected]

Sets Sensor Pose respect to the robot.

void MipResources::RangeSensmmPar::setName

(

string

value

)

[protected]

Sets the name.

RangeSensmmPar & MipResources::RangeSensmmPar::operator=

(

const RangeSensmmPar &

s

)

Assigment operator =.

UCoordmm MipResources::RangeSensmmPar::linRangeMax

(

)

Get Maximum Linear Range.

UCoordmm MipResources::RangeSensmmPar::linRangeMin

(

)

Get Minimum Linear Range.

UCoordmm MipResources::RangeSensmmPar::linRes

(

)

Get Linear Resolution.

Anglem MipResources::RangeSensmmPar::angRangeMax

(

)

Get Maximum Angular Range.

Anglem MipResources::RangeSensmmPar::angRangeMin

(

)

Get Minimum Angular Range.

Anglem MipResources::RangeSensmmPar::angRes

(

)

Get Angular Resolution.

int MipResources::RangeSensmmPar::numRays

(

)

Get Number of Rays.

Decimal MipResources::RangeSensmmPar::rate

(

)

Get Scan Rate.

Pose MipResources::RangeSensmmPar::pose

(

void

)

Get Sensor Pose respect to the robot.

string MipResources::RangeSensmmPar::name

(

)

Get the name.

string MipResources::RangeSensmmPar::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