Abstract class for iterating over lines. More...
#include <abstract_line_iterator.h>
Public Member Functions | |
| AbstractLineIterator () | |
| Public Constructor. | |
| virtual nav_grid::SignedIndex | getFinalIndex () const =0 |
| virtual void | increment ()=0 |
| Increase the iterator to the next element. | |
| bool | isFinished () |
| const nav_grid::SignedIndex & | operator* () const |
| Dereference the iterator. | |
Protected Member Functions | |
| AbstractLineIterator (nav_grid::SignedIndex index) | |
| Protected Constructor - takes arbitrary index. | |
Protected Attributes | |
| nav_grid::SignedIndex | index_ |
Detailed Description
Abstract class for iterating over lines.
Not constrained by a bounding box from NavGridInfo, i.e. can include positive and negative indexes
Definition at line 48 of file abstract_line_iterator.h.
Constructor & Destructor Documentation
Public Constructor.
Definition at line 54 of file abstract_line_iterator.h.
| nav_grid_iterators::AbstractLineIterator::AbstractLineIterator | ( | nav_grid::SignedIndex | index | ) | [inline, explicit, protected] |
Protected Constructor - takes arbitrary index.
Definition at line 78 of file abstract_line_iterator.h.
Member Function Documentation
| virtual nav_grid::SignedIndex nav_grid_iterators::AbstractLineIterator::getFinalIndex | ( | ) | const [pure virtual] |
Implemented in nav_grid_iterators::Bresenham, and nav_grid_iterators::RayTrace.
| virtual void nav_grid_iterators::AbstractLineIterator::increment | ( | ) | [pure virtual] |
Increase the iterator to the next element.
Implemented in nav_grid_iterators::Bresenham, and nav_grid_iterators::RayTrace.
| bool nav_grid_iterators::AbstractLineIterator::isFinished | ( | ) | [inline] |
Definition at line 64 of file abstract_line_iterator.h.
| const nav_grid::SignedIndex& nav_grid_iterators::AbstractLineIterator::operator* | ( | ) | const [inline] |
Dereference the iterator.
- Returns:
- the index to which the iterator is pointing.
Definition at line 60 of file abstract_line_iterator.h.
Member Data Documentation
nav_grid::SignedIndex nav_grid_iterators::AbstractLineIterator::index_ [protected] |
Definition at line 79 of file abstract_line_iterator.h.
The documentation for this class was generated from the following file: