MipResources::GroundSensPar Class Reference
[Ground sensor]

parameters of an Abstract Range-sensor More...

#include <GroundSens.h>

Inheritance diagram for MipResources::GroundSensPar:

List of all members.

Public Member Functions
	GroundSensPar ()
	Default constructor.
	GroundSensPar (const GroundSensPar &s)
	Copy constructor.
GroundSensPar &	operator= (const GroundSensPar &s)
	Assigment operator =.
Decimal	linRangeMax ()
	Gets param linRangeMax.
Decimal	linRangeMin ()
	Get param linRangeMin.
Decimal	linRes ()
	Gets param linRes.
Angle	angRangeMax ()
	Gets param angRangeMax.
Angle	angRangeMin ()
	Gets param angRangeMin.
Angle	angRes ()
	Gets param angRes.
string	numRays ()
	Gets param numRays.
Pose	pose ()
	Gets param pose.
string	name ()
	Gets param name.
string	print ()
	Print function.
Protected Member Functions
void	setLinRangeMin (Decimal value)
void	setLinRangeMax (Decimal value)
	Sets Maximum nimum 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 GroundSens

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

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

---

Constructor & Destructor Documentation

MipResources::GroundSensPar::GroundSensPar

(

)

Default constructor.

MipResources::GroundSensPar::GroundSensPar

(

const GroundSensPar &

s

)

Copy constructor.

---

Member Function Documentation

void MipResources::GroundSensPar::setLinRangeMin

(

Decimal

value

)

[inline, protected]

Note:

To be called before all

void MipResources::GroundSensPar::setLinRangeMax

(

Decimal

value

)

[inline, protected]

Sets Maximum nimum Linear Range.

Note:

To be called after setLinRangeMin

void MipResources::GroundSensPar::setLinRes

(

Decimal

value

)

[inline, protected]

sets Linear Resolution

Note:

To be called after setLinRangeMax

void MipResources::GroundSensPar::setAngRangeMax

(

Angle

value

)

[inline, protected]

sets Maximum Angular Range

Note:

To be called after ...

void MipResources::GroundSensPar::setAngRangeMin

(

Angle

value

)

[inline, protected]

sets Minimum Angular Range

Note:

To be called after ...

void MipResources::GroundSensPar::setAngRes

(

Angle

value

)

[inline, protected]

sets Angular Resolution

Note:

To be called after ...

void MipResources::GroundSensPar::setNumRays

(

uint32_t

value

)

[inline, protected]

sets the NumRays of a scan

Note:

To be called after ...

void MipResources::GroundSensPar::setRate

(

Decimal

value

)

[inline, protected]

sets the Scan Rate

Note:

To be called after ...

void MipResources::GroundSensPar::setPose

(

Pose

value

)

[inline, protected]

Sets Sensor Pose respect to the robot.

void MipResources::GroundSensPar::setName

(

string

value

)

[inline, protected]

Sets the name.

GroundSensPar & MipResources::GroundSensPar::operator=

(

const GroundSensPar &

s

)

Assigment operator =.

Decimal MipResources::GroundSensPar::linRangeMax

(

)

[inline]

Gets param linRangeMax.

Returns:

The requested value.

Decimal MipResources::GroundSensPar::linRangeMin

(

)

[inline]

Get param linRangeMin.

Returns:

The requested value.

Decimal MipResources::GroundSensPar::linRes

(

)

[inline]

Gets param linRes.

Returns:

The requested value.

Angle MipResources::GroundSensPar::angRangeMax

(

)

[inline]

Gets param angRangeMax.

Returns:

The requested value.

Angle MipResources::GroundSensPar::angRangeMin

(

)

[inline]

Gets param angRangeMin.

Returns:

The requested value.

Angle MipResources::GroundSensPar::angRes

(

)

[inline]

Gets param angRes.

Returns:

The requested value.

string MipResources::GroundSensPar::numRays

(

)

[inline]

Gets param numRays.

Returns:

The requested value.

Pose MipResources::GroundSensPar::pose

(

void

)

[inline]

Gets param pose.

Returns:

The requested value.

string MipResources::GroundSensPar::name

(

)

[inline]

Gets param name.

Returns:

The requested value.

string MipResources::GroundSensPar::print

(

)

[inline]

Print function.

Returns:

A printable string.

---

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

• resources/GroundSens/GroundSens.h
• resources/GroundSens/GroundSens.cpp