GNamed.hh

Go to the documentation of this file.

//======================================================================
/*! \file GNamed.hh
 *
 *  Include file for a named base object.
 */
//======================================================================

#ifndef G_NAMED_HH
#define G_NAMED_HH

#include "GGlobal.hh"
#include "GString.hh"


//======================================================================
/*! \class GNamed
 *
 *  Base class for named objects.
 */
//======================================================================
class GNamed
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GNamed)
//----------------------------------------------------------------------

  private:

  protected:
    string  name;       ///<  Object name

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
  public:
    GNamed ( const string & object_name = "" ); // inline
    GNamed ( const GNamed & object );           // inline
    virtual ~GNamed ( );                        // inline

    GNamed & operator = ( const GNamed &object ); // inline

  //------------------------------------------------------------
  //  Get / Set name
    virtual const string & Name ( ) const;    // inline
    virtual       string & Name ( );          // inline
    virtual       string   GetName ( ) const; // inline
    virtual       string   GetInfo ( ) const; // inline

    virtual void  SetName ( const string & object_name ); // inline

  //------------------------------------------------------------
  //  Comparison functions
    int Compare     ( const GNamed &object ) const;  // inline
    int CompareDict ( const GNamed &object ) const;  // inline

    bool operator == ( const GNamed &object ) const;  // inline
    bool operator != ( const GNamed &object ) const;  // inline
    bool operator <  ( const GNamed &object ) const;  // inline
    bool operator >  ( const GNamed &object ) const;  // inline
    bool operator <= ( const GNamed &object ) const;  // inline
    bool operator >= ( const GNamed &object ) const;  // inline

};

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

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