nav_grid_iterators::WholeGrid Class Reference

#include <whole_grid.h>

Inheritance diagram for nav_grid_iterators::WholeGrid:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Standard BaseIterator Interface
WholeGrid begin () const override
 Helper function for range-style iteration Equivalent to the above constructor.
WholeGrid end () const override
 Helper function for range-style iteration.
void increment () override
 Increase the iterator to the next element.

Detailed Description

An iterator that will iterate through all the cells of a grid in row-major order

Definition at line 46 of file whole_grid.h.


Member Function Documentation

WholeGrid nav_grid_iterators::WholeGrid::begin ( ) const [override, virtual]

Helper function for range-style iteration Equivalent to the above constructor.

Returns:
Iterator representing beginning of the iteration

Implements nav_grid_iterators::BaseIterator< WholeGrid >.

Definition at line 40 of file whole_grid.cpp.

WholeGrid nav_grid_iterators::WholeGrid::end ( ) const [override, virtual]

Helper function for range-style iteration.

Returns:
Iterator representing end of the iteration, with an invalid index

Implements nav_grid_iterators::BaseIterator< WholeGrid >.

Definition at line 45 of file whole_grid.cpp.

void nav_grid_iterators::WholeGrid::increment ( ) [override, virtual]

Increase the iterator to the next element.

Implements nav_grid_iterators::BaseIterator< WholeGrid >.

Definition at line 50 of file whole_grid.cpp.


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


nav_grid_iterators
Author(s):
autogenerated on Wed Jun 26 2019 20:09:45