LayoutIterator.H

Go to the documentation of this file.

#ifdef CH_LANG_CC
/*
*      _______              __
*     / ___/ /  ___  __ _  / /  ___
*    / /__/ _ \/ _ \/  V \/ _ \/ _ \
*    \___/_//_/\___/_/_/_/_.__/\___/
*    Please refer to Copyright.txt, in Chombo's root directory.
*/
#endif

#ifndef _LAYOUTITERATOR_H_
#define _LAYOUTITERATOR_H_



#include "DataIndex.H"
#include "BoxLayout.H"


#include "NamespaceHeader.H"


class LayoutIterator
{
public:
  LayoutIterator()
  {}

  // Default copy and null constructor should be fine.
  // Not useful to someone using the iterator.  Used by
  // other classes in Chombo.  Could make it private and
  // let BoxLayout have access....

  virtual ~LayoutIterator()
  {}

  const LayoutIndex& operator () () const;

  LayoutIndex i() const
  {
    return this->operator()();
  }

  virtual void operator ++ ();

  void incr()
  {
    ++(*this);
  }

  virtual bool ok() const;

  void begin();

  void reset();


  void end();


protected:
  friend class BoxLayout;
  friend class TimedDataIterator;
  LayoutIterator(const BoxLayout& a_boxlayout,
                 const int*       a_layoutID);

  BoxLayout    m_layout;
  unsigned int m_index;

  LayoutIndex  m_current;
};


inline const LayoutIndex& LayoutIterator::operator () () const
{
  CH_assert(ok());
  return m_current;
}

inline void LayoutIterator::operator ++ ()
{
  ++m_index;

  if (ok())
  {
    m_current.m_index = (*(m_layout.m_boxes))[m_index].index;
  }
}

inline bool LayoutIterator::ok() const
{
  return m_index < m_layout.size();
}

inline void LayoutIterator::begin()
{
  m_index = 0;

  if (ok())
  {
    m_current.m_index = (*(m_layout.m_boxes))[m_index].index;
  }
}


#include "NamespaceFooter.H"
#endif

---