CyclicIndex.h

// -*- C++ -*-

#if !defined(__geom_CyclicIndex_h__)
#define __geom_CyclicIndex_h__

// If we are debugging the whole geom namespace.
#if defined(DEBUG_geom) && !defined(DEBUG_CyclicIndex)
#define DEBUG_CyclicIndex
#endif

#include "../defs.h"

#include <cassert>

BEGIN_NAMESPACE_GEOM

class CyclicIndex {
  //
  // Data
  //

private:

  int _index, _n;

  //
  // Friends
  //

  friend CyclicIndex& operator++(CyclicIndex& ci);
  friend CyclicIndex& operator--(CyclicIndex& ci);

  CyclicIndex();

public:

  //--------------------------------------------------------------------------
  // @{

  CyclicIndex(const int n) : 
    _index(0), 
    _n(n) { 
#ifdef DEBUG_CyclicIndex
    assert(_n > 0); 
#endif
  }

  CyclicIndex(const CyclicIndex& other) : 
    _index(other._index), 
    _n(other._n) { 
#ifdef DEBUG_CyclicIndex
    assert(_n > 0); 
#endif
  }

  CyclicIndex& 
  operator=(const CyclicIndex& other);
  
  ~CyclicIndex()
  {}

  // @}
  //--------------------------------------------------------------------------
  // @{

  int 
  operator()() const { 
    return _index; 
  }

  // @}
  //--------------------------------------------------------------------------
  // @{

  void set(int i);
};

//
// Increment and Decrement Operators.
//
  

CyclicIndex& 
operator++(CyclicIndex& ci);


CyclicIndex& 
operator--(CyclicIndex& ci);

END_NAMESPACE_GEOM

#define __geom_CyclicIndex_ipp__
#include "CyclicIndex.ipp"
#undef __geom_CyclicIndex_ipp__

#endif

---