List of all members
nav_grid_iterators::WholeGrid Class Reference

#include <whole_grid.h>

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

Public Member Functions

Standard BaseIterator Interface
WholeGrid begin () const override
 Helper function for range-style iteration Equivalent to the above constructor. More...
 
WholeGrid end () const override
 Helper function for range-style iteration. More...
 
void increment () override
 Increase the iterator to the next element. More...
 
- Public Member Functions inherited from nav_grid_iterators::BaseIterator< WholeGrid >
 BaseIterator (const nav_grid::NavGridInfo *info)
 Public Constructor. Takes in a pointer to the info and starts at the minimum index. More...
 
 BaseIterator (const nav_grid::NavGridInfo &info)
 Public Constructor. Takes in a reference to the info and starts at the minimum index. More...
 
virtual bool fieldsEqual (const WholeGrid &other)
 Additional check for whether fields of derived iterators are equal. More...
 
bool operator!= (const WholeGrid &other)
 Test if two iterators are not equivalent - required for testing if iterator is at the end. More...
 
const nav_grid::Indexoperator* () const
 Dereference the iterator. More...
 
WholeGridoperator++ ()
 Increase the iterator to the next element. More...
 
bool operator== (const WholeGrid &other)
 Test if two iterators are equivalent. More...
 
virtual ~BaseIterator ()=default
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from nav_grid_iterators::BaseIterator< WholeGrid >
using difference_type = int
 
using iterator_category = std::input_iterator_tag
 
using pointer = nav_grid::Index *
 
using reference = nav_grid::Index &
 
using self_type = WholeGrid
 
using value_type = nav_grid::Index
 
- Protected Member Functions inherited from nav_grid_iterators::BaseIterator< WholeGrid >
 BaseIterator (const nav_grid::NavGridInfo *info, const nav_grid::Index &index)
 Protected constructor that takes in an arbitrary index. More...
 
- Protected Attributes inherited from nav_grid_iterators::BaseIterator< WholeGrid >
nav_grid::Index index_
 
const nav_grid::NavGridInfoinfo_
 

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
overridevirtual

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
overridevirtual

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 ( )
overridevirtual

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 Sun Jan 10 2021 04:08:42