Class PolygonIterator

Class Documentation

class PolygonIterator

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

Public Functions

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.

PolygonIterator &operator=(const PolygonIterator &other)

Assignment operator.

Parameters:

iterator – the iterator to copy data from.

Returns:

a reference to *this.

bool operator!=(const PolygonIterator &other) const

Compare to another iterator.

Returns:

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

const Index &operator*() const

Dereference the iterator with const.

Returns:

the value to which the iterator is pointing.

PolygonIterator &operator++()

Increase the iterator to the next element.

Returns:

a reference to the updated iterator.

bool isPastEnd() const

Indicates if iterator is past end.

Returns:

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