GNamedListT.hh

Go to the documentation of this file.

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

#ifndef G_NAMED_LIST_T_HH
#define G_NAMED_LIST_T_HH

#include "GSortListT.hh"
#include "GNamed.hh"

//======================================================================
/*! \class GNamedListT
 *
 *  Template class to define a sortable list (see GSortListT) of
 *  \b named objects, inheriting from the GNamed class (in order
 *  to define the required functions).
 *
 *  See \ref gcpp_templates for more information about the template classes.
 */
template <class T> class GNamedListT : public GSortListT<T>
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GNamedListT<T>)
  //------------------------------------------------------------

  using GCollectionT<T>::options;
  using GListT<T>::current_item;
  using GListT<T>::first_item;
  using GListT<T>::last_item;
  using GListT<T>::Null;
  using GListT<T>::Begin;
  using GListT<T>::End;

  public:
  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GNamedListT ( u_int fl = 0 );
    GNamedListT ( const GNamedListT<T> & list );
    GNamedListT ( const GNamedListT<T> & list, u_int fl );
    GNamedListT<T> & operator = ( const GNamedListT<T> & list );
    virtual ~GNamedListT ( );

  //------------------------------------------------------------
    virtual void    SetCaseSensitive ( bool b = true );
    virtual void    SetDictSort      ( bool b = true );

    virtual int           Compare   ( const T & obj1, const T & obj2 ) const;
    virtual bool          ExistName ( const string &obj_name ) const;
    virtual GListIterT<T> FindName  ( const string &obj_name, const char smod = 'f' ) const;
    virtual GListIterT<T> FindNameFirst    ( const string &obj_name ) const;
    virtual GListIterT<T> FindNameLast     ( const string &obj_name ) const;
    virtual GListIterT<T> FindNameNext     ( const string &obj_name ) const;
    virtual GListIterT<T> FindNamePrevious ( const string &obj_name ) const;

    virtual string      * CreateNamesTable ( ) const;
    virtual void          SetNamesTable    ( string table[] ) const;

  //------------------------------------------------------------
    virtual void  Print ( FILE * fp = stdout, const string & prefix = "" ) const;
    virtual void  Print ( ostream & os, const string & prefix = "" ) const;

  //------------------------------------------------------------
  // internal functions
  protected:
    virtual GListIterT<T>   __Add       ( T * item );  // redefined from GSortListT
    virtual GListIterT<T>   __Insert    ( T * item );  // redefined from GSortListT
    virtual GListIterT<T> * __FindName  ( const string &obj_name, const char smod = 'f' ) const;
};

//----------------------------------------------------------------------
// Inline and template functions
#include "icc/GNamedListT.icc"

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