GTreeBranchT.hh

Go to the documentation of this file.

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

#ifndef G_TREE_BRANCH_T_HH
#define G_TREE_BRANCH_T_HH

#include "GTreeNodeT.hh"
#include "GTreeLeafT.hh"

//======================================================================
/*! \class GTreeBranchT
 *
 *  A tree branch is a tree element itself, and a the list of tree elements
 *  that a contained in the branch.
 */
template <class T> class GTreeBranchT : public GTreeNodeT<T>,
                                        public GNamedListT<GTreeNodeT <T> >
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GTreeBranchT<T>)
  //------------------------------------------------------------

  using GNamed::GetName;
  using GNamed::SetName;

  using GNamedListT < GTreeNodeT <T> >::Null;
  using GNamedListT < GTreeNodeT <T> >::Begin;
  using GNamedListT < GTreeNodeT <T> >::End;
  using GNamedListT < GTreeNodeT <T> >::Goto;
  using GNamedListT < GTreeNodeT <T> >::Current;
  using GNamedListT < GTreeNodeT <T> >::Previous;
  using GNamedListT < GTreeNodeT <T> >::Next;
  using GNamedListT < GTreeNodeT <T> >::First;
  using GNamedListT < GTreeNodeT <T> >::Last;

  using GNamedListT < GTreeNodeT <T> >::Add;
  using GNamedListT < GTreeNodeT <T> >::Insert;
  using GNamedListT < GTreeNodeT <T> >::Append;
  using GNamedListT < GTreeNodeT <T> >::Prepend;

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

  protected:

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

  //------------------------------------------------------------
  /** @name Element information */
  //@{
    virtual bool    IsBranch ( ) const;     //inline

    virtual u_int   GetLeafCount      ( ) const;
    virtual u_int   GetBranchCount    ( ) const;
    virtual u_int   GetLeafTotalCount ( ) const;
  //@}

  //------------------------------------------------------------
  /** @name Tree structure exploration */
  //@{
    virtual GTreeNodeT<T> * NextNode     ( );
  //@}


  //------------------------------------------------------------
  /** @name Tree construction function */
  //@{
    virtual GTreeBranchT<T> * AddBranch ( const string & bname ); // inline
    virtual GTreeLeafT<T>   * AddLeaf   ( T & object_ref );       // inline
    virtual GTreeLeafT<T>   * AddLeaf   ( T * object_ptr );       // inline
  //@}

  protected:
  /** @name Internal functions redefined for list behaviour */
  //@{
    virtual GListIterT<GTreeNodeT <T> > __Add    ( GTreeNodeT<T> * item );
    virtual GListIterT<GTreeNodeT <T> > __Insert ( GTreeNodeT<T> * item );
    virtual GTreeNodeT<T>             * __Take   ( );
  //@}

  public:

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

    virtual GTreeBranchT<T>   * CreateFolderTree ( ) const;
  //@}

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

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

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