GListIterT.hh

Go to the documentation of this file.

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

#ifndef G_LIST_ITER_T_HH
#define G_LIST_ITER_T_HH

#include "GIterT.hh"

template < class T > class GListT;

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

  friend class GListT<T>;

  protected:
    GListIterT<T> * previous_item;  ///< Pointer on the list iterator of previous item
    GListIterT<T> * next_item;      ///< Pointer on the list iterator of next item

  public:

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GListIterT ( );
    GListIterT ( const GListIterT<T> & p );
    virtual ~GListIterT ( );
    GListIterT<T> & operator = ( const GListIterT<T> & p );

  //------------------------------------------------------------
    void SetPreviousIterPtr ( GListIterT<T> * iter_ptr );
    void SetNextIterPtr     ( GListIterT<T> * iter_ptr );

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

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

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

  //------------------------------------------------------------
    const GListIterT<T> * PreviousIterPtr ( ) const;
    const GListIterT<T> * NextIterPtr     ( ) const;
    GListIterT<T>       * PreviousIterPtr ( );
    GListIterT<T>       * NextIterPtr     ( );
    GListIterT<T>   Previous ( ) const;
    GListIterT<T>   Next     ( ) const;

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


//----------------------------------------------------------------------
// Inline and template functions
#include "icc/GListIterT.icc"


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