GPointer.hh

Go to the documentation of this file.

//======================================================================
/*! \file GPointer.hh
 *
 *  Include file for class GPointer, containing a pointer of any type.
 */
//======================================================================

#ifndef G_POINTER_HH
#define G_POINTER_HH

#include "GGlobal.hh"

/*! \class GPointer
 *
 *  This class defines a pointer on any kind of object.
 *  It is used as an interface for collections, that does not accept
 *  base type pointers (that does not contain the GObject functions).
 */

class GPointer
{
  //------------------------------------------------------------
  /* \object_doc */
  GObject(GPointer)
  //------------------------------------------------------------

  protected:
    void    * pointer;    ///< Pointer on user data

  public:

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GPointer ( void *ptr = NULL );
    GPointer ( const GPointer &original );

    virtual ~GPointer ( );

    GPointer & operator = ( const GPointer &original );

  //----------------------------------------------------------
  // Comparison operators
    virtual bool  operator == ( const GPointer &ptr );

  //----------------------------------------------------------
  // Get / Set functions
    void  * GetPointer ( ) const;
    void    SetPointer ( void * ptr );

};

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

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