Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nav_grid_iterators::AbstractLineIterator Class Referenceabstract

Abstract class for iterating over lines. More...

#include <abstract_line_iterator.h>

Inheritance diagram for nav_grid_iterators::AbstractLineIterator:
Inheritance graph

Public Member Functions

 AbstractLineIterator ()
 Public Constructor. More...
virtual nav_grid::SignedIndex getFinalIndex () const =0
virtual void increment ()=0
 Increase the iterator to the next element. More...
bool isFinished ()
const nav_grid::SignedIndexoperator* () const
 Dereference the iterator. More...

Protected Member Functions

 AbstractLineIterator (nav_grid::SignedIndex index)
 Protected Constructor - takes arbitrary index. More...

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

nav_grid_iterators::AbstractLineIterator::AbstractLineIterator ( )

Public Constructor.

Definition at line 54 of file abstract_line_iterator.h.

nav_grid_iterators::AbstractLineIterator::AbstractLineIterator ( nav_grid::SignedIndex  index)

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

Definition at line 64 of file abstract_line_iterator.h.

const nav_grid::SignedIndex& nav_grid_iterators::AbstractLineIterator::operator* ( ) const

Dereference the iterator.

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_

Definition at line 79 of file abstract_line_iterator.h.

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

autogenerated on Sun Jan 10 2021 04:08:42