MipBaselib::PerceptionGridPar Class Reference

A class to control the parameters of the Grid. More...

#include <PerceptionGrid.h>

Inheritance diagram for MipBaselib::PerceptionGridPar:

List of all members.

Public Member Functions
	PerceptionGridPar ()
	the default empty constructor
	PerceptionGridPar (ScanPar scanPar, Pose center, Decimal cellSize, int nCellX, int nCellY)
	The contructor.
	PerceptionGridPar (const PerceptionGridPar &g)
	Copy constructor.
PerceptionGridPar &	operator= (const PerceptionGridPar &g)
	Operator =.
Pose	center ()
	Returns the center of the grid.
Decimal	cellSize ()
	Returns the size of a cell.
int	nCellX ()
	Returns the number of cells on the X axis.
int	nCellY ()
	Returns the number of cells of the Y axis.
Decimal	width ()
	Computes and returns the width of the grid.
Decimal	height ()
	Computes and returns the height of the grid.
bool	setSize (Decimal height, Decimal width, Decimal cellSize)
	Computes the new size of cell that best fits the given height, width and cellSize.
bool	setSize (Decimal width, int nCellX, int nCellY)
	Computes the new size of cell that best fits the given height, width and cellSize.
string	getObjectName () const
	Gets the name.
ScanPar *	scanPar ()
	Gets a pointer to the paramenters of the scan.

---

Detailed Description

A class to control the parameters of the Grid.

Author:

Arnaud Dufranne.

---

Constructor & Destructor Documentation

MipBaselib::PerceptionGridPar::PerceptionGridPar

(

)

the default empty constructor

MipBaselib::PerceptionGridPar::PerceptionGridPar	(	ScanPar	scanPar,
		Pose	center,
		Decimal	cellSize,
		int	nCellX,
		int	nCellY
	)

The contructor.

Parameters:

[in]	params	The scan params.
[in]	currScan	The current Scan.
[in]	center	The absolute Pose of the center of the Grid.
[in]	cellSize	The size of a cell in meters.
[in]	nCellX	The number of width cells of the Grid.
[in]	nCellY	The number of height cells of the Grid.

MipBaselib::PerceptionGridPar::PerceptionGridPar

(

const PerceptionGridPar &

g

)

Copy constructor.

---

Member Function Documentation

PerceptionGridPar & MipBaselib::PerceptionGridPar::operator=

(

const PerceptionGridPar &

g

)

Operator =.

Pose MipBaselib::PerceptionGridPar::center

(

)

[inline]

Returns the center of the grid.

Decimal MipBaselib::PerceptionGridPar::cellSize

(

)

[inline]

Returns the size of a cell.

int MipBaselib::PerceptionGridPar::nCellX

(

)

[inline]

Returns the number of cells on the X axis.

int MipBaselib::PerceptionGridPar::nCellY

(

)

[inline]

Returns the number of cells of the Y axis.

Decimal MipBaselib::PerceptionGridPar::width

(

)

[inline]

Computes and returns the width of the grid.

Decimal MipBaselib::PerceptionGridPar::height

(

)

[inline]

Computes and returns the height of the grid.

bool MipBaselib::PerceptionGridPar::setSize	(	Decimal	height,
		Decimal	width,
		Decimal	cellSize
	)

Computes the new size of cell that best fits the given height, width and cellSize.

Note:

The width and height of the Grid may not be the ones specified in the parameters.

bool MipBaselib::PerceptionGridPar::setSize	(	Decimal	width,
		int	nCellX,
		int	nCellY
	)

Computes the new size of cell that best fits the given height, width and cellSize.

Note:

The width and height of the Grid may not be the ones specified in the parameters.

string MipBaselib::PerceptionGridPar::getObjectName

(

)

const [inline, virtual]

Gets the name.

Implements MIPObject.

ScanPar * MipBaselib::PerceptionGridPar::scanPar

(

)

[inline]

Gets a pointer to the paramenters of the scan.

---

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

• baselib/Grid/PerceptionGrid.h
• baselib/Grid/PerceptionGrid.cpp