extent_iterator.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2011 by the OpenStructure authors
// Copyright (C) 2003-2010 by the IPLT authors
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 3.0 of the License, or (at your option)
// any later version.
// This library is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------

/*
  iterate over a volume defined by an extent

  Author: Ansgar Philippsen
*/

#ifndef IMG_EXTENT_ITERATOR_H
#define IMG_EXTENT_ITERATOR_H

#include "point.hh"
#include "data.hh"

namespace ost { namespace img {

class Extent;


class DLLEXPORT_OST_IMG_BASE ExtentIterator {
 public:
  explicit ExtentIterator(const Extent& b, unsigned int domain=SPATIAL);

  ExtentIterator(const ExtentIterator &i);

  ExtentIterator& operator=(const ExtentIterator& p);

  ExtentIterator& operator++();

  ExtentIterator operator++(int);

  ExtentIterator& operator--(); 

  ExtentIterator operator--(int);

  void Inc();

  void Dec();

  ExtentIterator& ToStart();

  ExtentIterator& ToEnd();

  Extent GetExtent() const;

  const Point &GetStart() const;

  const Point &GetEnd() const;

  bool AtEnd() const;

  bool AtStart() const;

  int operator[](int i) const;

  operator Point() const;

 private:
  Point start_, end_, current_,startpos_;
};

}} // namespace img

#endif