Class SpiralIterator

Class Documentation

class SpiralIterator

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

Public Functions

SpiralIterator(const grid_map::GridMap &gridMap, const Eigen::Vector2d &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.

SpiralIterator &operator=(const SpiralIterator &other)

Assignment operator.

Parameters:

iterator – the iterator to copy data from.

Returns:

a reference to *this.

bool operator!=(const SpiralIterator &other) const

Compare to another iterator.

Returns:

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

const Eigen::Array2i &operator*() const

Dereference the iterator with const.

Returns:

the value to which the iterator is pointing.

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

double getCurrentRadius() const

Gets the radius of current ring that is iterated through.

Returns:

radius of the current ring that is used for iteration.