grid_map::SubmapIterator Class Reference

#include <SubmapIterator.hpp>

Public Member Functions
const Index &	getSubmapIndex () const
const Size &	getSubmapSize () const
bool	isPastEnd () const
bool	operator!= (const SubmapIterator &other) const
const Index &	operator* () const
SubmapIterator &	operator++ ()
SubmapIterator &	operator= (const SubmapIterator &other)
	SubmapIterator (const grid_map::SubmapGeometry &submap)
	SubmapIterator (const grid_map::GridMap &gridMap, const grid_map::BufferRegion &bufferRegion)
	SubmapIterator (const grid_map::GridMap &gridMap, const Index &submapStartIndex, const Size &submapSize)
	SubmapIterator (const SubmapIterator *other)

Private Attributes
Index	index_
	Current index. More...
bool	isPastEnd_
	Is iterator out of scope. More...
Size	size_
	Size of the buffer. More...
Index	startIndex_
	Start index of the circular buffer. More...
Index	submapIndex_
	Current index in the submap. More...
Size	submapSize_
	Submap buffer size. More...
Index	submapStartIndex_
	Top left index of the submap. More...

Detailed Description

Iterator class to iterate through a rectangular part of the map (submap). Before using this iterator, make sure that the requested submap is actually contained in the grid map.

Definition at line 24 of file SubmapIterator.hpp.

Constructor & Destructor Documentation

grid_map::SubmapIterator::SubmapIterator

(

const grid_map::SubmapGeometry &

submap

)

Constructor.

Parameters

submap

the submap geometry to iterate over.

Definition at line 16 of file SubmapIterator.cpp.

grid_map::SubmapIterator::SubmapIterator	(	const grid_map::GridMap &	gridMap,
		const grid_map::BufferRegion &	bufferRegion
	)

Constructor.

Parameters

submap

the buffer region of a grid map to iterate over.

Definition at line 21 of file SubmapIterator.cpp.

grid_map::SubmapIterator::SubmapIterator	(	const grid_map::GridMap &	gridMap,
		const Index &	submapStartIndex,
		const Size &	submapSize
	)

Constructor.

Parameters

gridMap	the grid map to iterate on.
submapStartIndex	the start index of the submap, typically top-left index.
submapSize	the size of the submap to iterate on.

Definition at line 28 of file SubmapIterator.cpp.

grid_map::SubmapIterator::SubmapIterator

(

const SubmapIterator *

other

)

Copy constructor.

Parameters

other

the object to copy.

Definition at line 40 of file SubmapIterator.cpp.

Member Function Documentation

const Index & grid_map::SubmapIterator::getSubmapIndex

(

)

const

Get the current index in the submap.

Returns

the current index in the submap.

Definition at line 73 of file SubmapIterator.cpp.

const Size & grid_map::SubmapIterator::getSubmapSize

(

)

const

Returns the size of the submap covered by the iterator.

Returns

the size of the submap covered by the iterator.

Definition at line 90 of file SubmapIterator.cpp.

bool grid_map::SubmapIterator::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 85 of file SubmapIterator.cpp.

bool grid_map::SubmapIterator::operator!=

(

const SubmapIterator &

other

)

const

Compare to another iterator.

Returns

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

Definition at line 63 of file SubmapIterator.cpp.

const Index & grid_map::SubmapIterator::operator*

(

)

const

Dereference the iterator with const.

Returns

the value to which the iterator is pointing.

Definition at line 68 of file SubmapIterator.cpp.

SubmapIterator & grid_map::SubmapIterator::operator++

(

)

Increase the iterator to the next element.

Returns

a reference to the updated iterator.

Definition at line 78 of file SubmapIterator.cpp.

SubmapIterator & grid_map::SubmapIterator::operator=

(

const SubmapIterator &

other

)

Assignment operator.

Parameters

iterator

the iterator to copy data from.

Returns

a reference to *this.

Definition at line 51 of file SubmapIterator.cpp.

Member Data Documentation

Index grid_map::SubmapIterator::index_

private

Current index.

Definition at line 107 of file SubmapIterator.hpp.

bool grid_map::SubmapIterator::isPastEnd_

private

Is iterator out of scope.

Definition at line 119 of file SubmapIterator.hpp.

Size grid_map::SubmapIterator::size_

private

Size of the buffer.

Definition at line 101 of file SubmapIterator.hpp.

Index grid_map::SubmapIterator::startIndex_

private

Start index of the circular buffer.

Definition at line 104 of file SubmapIterator.hpp.

Index grid_map::SubmapIterator::submapIndex_

private

Current index in the submap.

Definition at line 116 of file SubmapIterator.hpp.

Size grid_map::SubmapIterator::submapSize_

private

Submap buffer size.

Definition at line 110 of file SubmapIterator.hpp.

Index grid_map::SubmapIterator::submapStartIndex_

private

Top left index of the submap.

Definition at line 113 of file SubmapIterator.hpp.

---

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

• SubmapIterator.hpp
• SubmapIterator.cpp