GVectIterT.hh

Go to the documentation of this file.

//======================================================================
/*! \file GVectIterT.hh
 *
 *  Include file for GVectIterT template class.
 */
//======================================================================

#ifndef G_VECT_ITER_T_HH
#define G_VECT_ITER_T_HH

#include "GIterT.hh"

template < class T > class GVectT;

//======================================================================
/*! \class GVectIterT
 *
 *  The template class GVectIterT defines the vector collections
 *  iterator.
 */
template < class T > class GVectIterT : public GIterT<T>
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GVectIterT<T>)
  //------------------------------------------------------------

  friend class GVectT<T>;

  protected:
    GVectT<T> * vector_ptr;   ///< Vector the iterator points to
    int         index;        ///< Index in the vector array

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
  public:
    GVectIterT ( );
    GVectIterT ( const GVectIterT<T> & p );
  protected:
    GVectIterT ( const GVectT<T> * vect, int ind );
  public:
    virtual ~GVectIterT ( );
    GVectIterT<T> & operator = ( const GVectIterT<T> & p );

  //------------------------------------------------------------
    const GVectT<T> * GetVectorPtr( ) const;
          GVectT<T> * GetVectorPtr( );

  //------------------------------------------------------------
  //  Cast, reference and dereference

  //------------------------------------------------------------
  //  Comparison operators
    virtual bool operator == ( const GVectIterT<T> & p ) const;
    virtual bool operator != ( const GVectIterT<T> & p ) const;

    virtual bool operator == ( const T * p ) const;
    virtual bool operator != ( const T * p ) const;

  //------------------------------------------------------------
  //  Incrementation / decrementation
    GVectIterT<T> & operator ++ ( void );
    GVectIterT<T> & operator -- ( void );
    GVectIterT<T>   operator ++ ( int );
    GVectIterT<T>   operator -- ( int );

  //------------------------------------------------------------
    virtual int Index ( ) const;
};


//----------------------------------------------------------------------
// Inline functions
#include "icc/GVectIterT.icc"


//======================================================================
#endif