Class CircleIterator

Class Documentation

class CircleIterator

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

Public Functions

CircleIterator(const GridMap &gridMap, const Position &center, const double radius)

Constructor.

Parameters:

  • gridMap – the grid map to iterate on.

  • center – the position of the circle center.

  • radius – the radius of the circle.

CircleIterator &operator=(const CircleIterator &other)

Assignment operator.

Parameters:

iterator – the iterator to copy data from.

Returns:

a reference to *this.

bool operator!=(const CircleIterator &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.

CircleIterator &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.