Class EllipseIterator

Class Documentation

class EllipseIterator

Iterator class to iterate through a ellipsoid area of the map. The main axis of the ellipse are aligned with the map frame.

Public Functions

EllipseIterator(const GridMap &gridMap, const Position &center, const Length &length, const double rotation = 0.0)

Constructor.

Parameters:

  • gridMap – the grid map to iterate on.

  • center – the position of the ellipse center.

  • length – the length of the main axis.

  • angle – the rotation angle of the ellipse (in [rad]).

EllipseIterator &operator=(const EllipseIterator &other)

Assignment operator.

Parameters:

iterator – the iterator to copy data from.

Returns:

a reference to *this.

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

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

const Size &getSubmapSize() const

Returns the size of the submap covered by the iterator.

Returns:

the size of the submap covered by the iterator.