GSortListT.hh

Go to the documentation of this file.

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

#ifndef G_SORT_LIST_T_HH
#define G_SORT_LIST_T_HH

#include "GListT.hh"

//======================================================================
/*! \class GSortListT
 *
 *  Template class to define a sortable list of objects.
 *
 *  If the gcollection::gAlwaysSorted flags are set, then elements are inserted
 *  at their sorted position, and cannot be moved.
 *  Else they are inserted at current position, like in the base class,
 *  and the list is sorted only if the Sort() function is called.
 *
 *  The objects class must define the \b Compare() function, on which the
 *  sorting is based (returning -1, 0 or 1).
 *
 *  See \ref gcpp_templates for more information about the template classes.
 */
template <class T> class GSortListT : public GListT<T>
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GSortListT<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
    GSortListT ( u_int fl = 0 );
    GSortListT ( const GSortListT<T> & list );
    GSortListT ( const GListT<T> & list );
    GSortListT ( const GListT<T> & list, u_int fl );
    GSortListT<T> & operator = ( const GListT<T> & list );
    virtual ~GSortListT ( );

  //------------------------------------------------------------
    virtual void ReverseSort ( );
    virtual int  Compare     ( const T & obj1, const T & obj2 ) const;

    virtual void Sort     ( );
    virtual bool IsSorted ( ) const;

  //------------------------------------------------------------
  // internal functions
  protected:
    virtual GListIterT<T> __Add       ( T * item );  // redefined from GListT
    virtual GListIterT<T> __Insert    ( T * item );  // redefined from GListT
    virtual GListIterT<T> __AddSorted ( T * item );
};

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


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