GridMapIterator.hpp

Go to the documentation of this file.

/*
 * GridMapIterator.hpp
 *
 *  Created on: Sep 22, 2014
 *      Author: Péter Fankhauser
 *   Institute: ETH Zurich, ANYbotics
 */

#pragma once

#include "grid_map_core/GridMap.hpp"

// Eigen
#include <Eigen/Core>

namespace grid_map {

class GridMapIterator
{
public:

  GridMapIterator(const grid_map::GridMap &gridMap);

  GridMapIterator(const GridMapIterator* other);

  bool operator !=(const GridMapIterator& other) const;

  Index operator *() const;

  const size_t& getLinearIndex() const;

  Index getUnwrappedIndex() const;

  virtual GridMapIterator& operator ++();

  GridMapIterator end() const;

  bool isPastEnd() const;

 protected:
  // NOLINTBEGIN(misc-non-private-member-variables-in-classes)
  Size size_;

  Index startIndex_;

  size_t linearSize_;

  size_t linearIndex_;

  bool isPastEnd_;
  // NOLINTEND(misc-non-private-member-variables-in-classes)

 public:
  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
};

}  // namespace grid_map