#include <costmap_iterator.hpp>
Public Member Functions | |
CostMapIterator (const cost_map::CostMap &gridMap) | |
CostMapIterator (const CostMapIterator *other) | |
CostMapIterator | end () const |
const Index | getUnwrappedIndex () const |
bool | isPastEnd () const |
bool | operator!= (const CostMapIterator &other) const |
const Index & | operator* () const |
CostMapIterator & | operator++ () |
CostMapIterator & | operator= (const CostMapIterator &other) |
Private Attributes | |
Index | endIndex_ |
End index of the circular buffer. | |
Index | index_ |
Current index. | |
bool | isPastEnd_ |
Is iterator out of scope. | |
Size | size_ |
Size of the buffer. | |
Index | startIndex_ |
Start index of the circular buffer. |
Iterator class to iterate trough the entire grid map.
Definition at line 15 of file costmap_iterator.hpp.
cost_map::CostMapIterator::CostMapIterator | ( | const cost_map::CostMap & | gridMap | ) |
Constructor.
gridMap | the grid map to iterate on. |
Definition at line 14 of file cost_map_iterator.cpp.
cost_map::CostMapIterator::CostMapIterator | ( | const CostMapIterator * | other | ) |
Copy constructor.
other | the object to copy. |
Definition at line 24 of file cost_map_iterator.cpp.
Return the end iterator
Definition at line 64 of file cost_map_iterator.cpp.
const Index cost_map::CostMapIterator::getUnwrappedIndex | ( | ) | const |
Retrieve the index as unwrapped index, i.e., as the corresponding index of a grid map with no circular buffer offset.
Definition at line 53 of file cost_map_iterator.cpp.
bool cost_map::CostMapIterator::isPastEnd | ( | ) | const |
Indicates if iterator is past end.
Definition at line 71 of file cost_map_iterator.cpp.
bool cost_map::CostMapIterator::operator!= | ( | const CostMapIterator & | other | ) | const |
Compare to another iterator.
Definition at line 43 of file cost_map_iterator.cpp.
const Index & cost_map::CostMapIterator::operator* | ( | ) | const |
Dereference the iterator with const.
Definition at line 48 of file cost_map_iterator.cpp.
CostMapIterator & cost_map::CostMapIterator::operator++ | ( | ) |
Increase the iterator to the next element.
Definition at line 58 of file cost_map_iterator.cpp.
CostMapIterator & cost_map::CostMapIterator::operator= | ( | const CostMapIterator & | other | ) |
Assignment operator.
iterator | the iterator to copy data from. |
Definition at line 33 of file cost_map_iterator.cpp.
Index cost_map::CostMapIterator::endIndex_ [private] |
End index of the circular buffer.
Definition at line 83 of file costmap_iterator.hpp.
Index cost_map::CostMapIterator::index_ [private] |
Current index.
Definition at line 86 of file costmap_iterator.hpp.
bool cost_map::CostMapIterator::isPastEnd_ [private] |
Is iterator out of scope.
Definition at line 89 of file costmap_iterator.hpp.
Size cost_map::CostMapIterator::size_ [private] |
Size of the buffer.
Definition at line 77 of file costmap_iterator.hpp.
Index cost_map::CostMapIterator::startIndex_ [private] |
Start index of the circular buffer.
Definition at line 80 of file costmap_iterator.hpp.