GTreeLeafT.hh

Go to the documentation of this file.

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

#ifndef G_TREE_LEAF_T_HH
#define G_TREE_LEAF_T_HH

#include "GTreeNodeT.hh"

//======================================================================
/*! \class GTreeLeafT
 *
 *  A tree leaf is a final tree element (it does not contain sub-elements).
 *
 *  Since the template class \b T must inherit from the base class GNamed,
 *  the functions related to the leaf (that also inherits from GNamed class)
 *  \b name and \b information are overloaded to be redirected to the
 *  type \b T object.
 */
template <class T> class GTreeLeafT : public GTreeNodeT<T>
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GTreeLeafT<T>)
  //------------------------------------------------------------

  using GTreeNodeT <T>::parent;
  using GTreeNodeT <T>::list_iter;

  protected:
    T *     data_ptr;   ///< Pointer to the object associated with the leaf
    bool    adopted;    ///< Flag if data object should be deleted by the tree

  public:
  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GTreeLeafT ( T & object_ref );  // 
    GTreeLeafT ( T * object_ptr );
    GTreeLeafT ( const GTreeLeafT<T> & original );
    virtual ~GTreeLeafT ( );
  //@}

  //------------------------------------------------------------
  /** @name Element information */
  //@{
  //  Redefined from GNamed base class
    virtual void    SetName ( const string & leaf_name ); // inline
    virtual string  GetName ( ) const;                    // inline
    virtual string  GetInfo ( ) const;                    // inline

  //  Mandatory functions from the base class
    virtual u_int   GetLeafCount      ( ) const;          // inline
    virtual u_int   GetLeafTotalCount ( ) const;          // inline

  //------------------------------------------------------------
    const T * GetDataPtr ( ) const;     // inline
          T * GetDataPtr ( );           // inline
    const T & GetData    ( ) const;     // inline
          T & GetData    ( );           // inline

    bool  IsObjectAdopted ( ) const;    // inline

    virtual bool  IsLeaf   ( ) const;   //inline
  //@}

  //------------------------------------------------------------
  /** @name Creation of objects structures from the tree */
  //@{
    virtual GTreeNodeT<GItem> * CreateItemTree ( ) const;
  //@}

  //------------------------------------------------------------
  /** @name Print out */
  //@{
    virtual void  Print ( FILE * fp = stdout, const string & prefix = "", bool info = false ) const;
  //@}
};

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

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