GIterT.hh

Go to the documentation of this file.

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

#ifndef G_ITER_T_HH
#define G_ITER_T_HH

#include "GGlobal.hh"

//======================================================================
/*! \class GIterT
 *
 *  The template class GIterT is a base class for collection iterators.
 *  It should be derived for specific types of collections.
 *
 *  The base class encapsulates a standard class T object pointer.
 */
template < class T > class GIterT
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GIterT<T>)
//----------------------------------------------------------------------

  protected:
    u_int flags;      ///< Iterator flags
    T   * item_ptr;   ///< Pointer on the instance of class T object

  public:
  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GIterT ( T * adr = NULL );
    GIterT ( const GIterT<T> & p );
    virtual  ~GIterT ( );

    GIterT<T> & operator = ( const GIterT<T> & p );
    GIterT<T> & operator = ( T * adr );

    void SetItemPtr ( T * adr );

  //------------------------------------------------------------
    u_int GetFlags  ( ) const;
    void  SetFlags  ( u_int fl );
    void  SetFlag   ( u_int fl, bool on = true );
    bool  IsFlagOn  ( u_int fl ) const;
    bool  IsFlagOff ( u_int fl ) const;

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

    operator bool ( void ) const;
    operator T *  ( void ) const;

    virtual       T & operator *  ( void );
    virtual       T * operator -> ( void );
    virtual const T & operator *  ( void ) const;
    virtual const T * operator -> ( void ) const;

  //------------------------------------------------------------
  //  Comparison operators

    virtual bool operator == ( const GIterT<T> & p ) const;
    virtual bool operator != ( const GIterT<T> & p ) const;
    virtual bool operator == ( const T * adr ) const;
    virtual bool operator != ( const T * adr ) const;

  //------------------------------------------------------------
  //  Incrementation / decrementation

    // not virtual since derived classes return another type of iterators
    GIterT<T> & operator ++ ( void );
    GIterT<T> & operator -- ( void );
    GIterT<T>   operator ++ ( int );
    GIterT<T>   operator -- ( int );

  //------------------------------------------------------------
    T * GetPointer ( );
};


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


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