#include <PolygonIterator.hpp>

Public Member Functions
bool	isPastEnd () const

bool	operator!= (const PolygonIterator &other) const

const Index &	operator* () const

PolygonIterator &	operator++ ()

PolygonIterator &	operator= (const PolygonIterator &other)

	PolygonIterator (const grid_map::GridMap &gridMap, const grid_map::Polygon &polygon)

Private Member Functions
void	findSubmapParameters (const grid_map::Polygon &polygon, Index &startIndex, Size &bufferSize) const

bool	isInside () const

Private Attributes
Size	bufferSize_

Index	bufferStartIndex_

std::shared_ptr< SubmapIterator >	internalIterator_
	Grid submap iterator. More...

Length	mapLength_
	Map information needed to get position from iterator. More...

Position	mapPosition_

grid_map::Polygon	polygon_
	Polygon to iterate on. More...

double	resolution_

Detailed Description

Iterator class to iterate through a polygonal area of the map.

Definition at line 22 of file PolygonIterator.hpp.

Constructor & Destructor Documentation

grid_map::PolygonIterator::PolygonIterator	(	const grid_map::GridMap &	gridMap,
		const grid_map::Polygon &	polygon
	)

Constructor.

Parameters

gridMap	the grid map to iterate on.
polygon	the polygonal area to iterate on.

Definition at line 16 of file PolygonIterator.cpp.

Member Function Documentation

void grid_map::PolygonIterator::findSubmapParameters	(	const grid_map::Polygon &	polygon,
		Index &	startIndex,
		Size &	bufferSize
	)		const

private

Finds the submap that fully contains the polygon and returns the parameters.

Parameters

[in]	polygon	the polygon to get the submap for.
[out]	startIndex	the start index of the submap.
[out]	bufferSize	the buffer size of the submap.

Definition at line 77 of file PolygonIterator.cpp.

bool grid_map::PolygonIterator::isInside ( ) const

private

Check if current index is inside polygon.

Returns: true if inside, false otherwise.

Definition at line 70 of file PolygonIterator.cpp.

bool grid_map::PolygonIterator::isPastEnd ( ) const

Indicates if iterator is past end.

Returns: true if iterator is out of scope, false if end has not been reached.

Definition at line 65 of file PolygonIterator.cpp.

bool grid_map::PolygonIterator::operator!= ( const PolygonIterator & other ) const

Compare to another iterator.

Returns: whether the current iterator points to a different address than the other one.

Definition at line 43 of file PolygonIterator.cpp.

const Index & grid_map::PolygonIterator::operator* ( ) const

Dereference the iterator with const.

Returns: the value to which the iterator is pointing.

Definition at line 48 of file PolygonIterator.cpp.

PolygonIterator & grid_map::PolygonIterator::operator++ ( )

Increase the iterator to the next element.

Returns: a reference to the updated iterator.

Definition at line 53 of file PolygonIterator.cpp.

PolygonIterator & grid_map::PolygonIterator::operator= ( const PolygonIterator & other )

Assignment operator.

Parameters

iterator the iterator to copy data from.

Returns: a reference to *this.

Definition at line 31 of file PolygonIterator.cpp.

Member Data Documentation

Size grid_map::PolygonIterator::bufferSize_

private

Definition at line 90 of file PolygonIterator.hpp.

Index grid_map::PolygonIterator::bufferStartIndex_

private

Definition at line 91 of file PolygonIterator.hpp.

std::shared_ptr<SubmapIterator> grid_map::PolygonIterator::internalIterator_

private

Grid submap iterator.

Definition at line 84 of file PolygonIterator.hpp.

Length grid_map::PolygonIterator::mapLength_

private

Map information needed to get position from iterator.

Definition at line 87 of file PolygonIterator.hpp.

Position grid_map::PolygonIterator::mapPosition_

private

Definition at line 88 of file PolygonIterator.hpp.

grid_map::Polygon grid_map::PolygonIterator::polygon_

private

Polygon to iterate on.

Definition at line 81 of file PolygonIterator.hpp.

double grid_map::PolygonIterator::resolution_

private

Definition at line 89 of file PolygonIterator.hpp.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation