GCollectionT.hh

Go to the documentation of this file.

//======================================================================
/*! \file GCollectionT.hh
 *
 *  Include file for GCollection base template class.
 */
//======================================================================

#ifndef G_COLLECTION_T_HH
#define G_COLLECTION_T_HH

#include "GGlobal.hh"
#include "GLogMessage.hh"

/*! Define values for collections behaviour flags.
 */
namespace gcollection
{

  //------------------------------------------------------------
  /** @name Iterator flags */
  //@{

    /*! Iterator flag inicating that the object must be deleted when removed
     *  from the collection.
     */
    static const u_int gDelete          = 0x00000001;

  //@}

  //------------------------------------------------------------
  /** @name General collections options */
  //@{

    /*! Indicates that if an object is added to the collection by reference,
     *  a copy of the object is made (with Clone() function), and the new
     *  object is adopted by the list.
     */
    static const u_int gDeepCopy        = 0x00001000;

    /*! An object must not be refered several times in the same collection
     *  (default check is based on pointer comparison, but for named objects
     *  it may be based on objects names).*/
    static const u_int gUniqueItem      = 0x00002000;

    /*! The position of elements cannot be moved once inserted.*/
    static const u_int gFixed           = 0x00020000;

    /*! The collection can be sorted: the comparison function (Compare) must be
     *  defined.*/
    static const u_int gIsSortable      = 0x00010000;

    /*! The objects are entered sorted and the collection remains sorted
     *  (objects cannot be moved).*/
    static const u_int gAlwaysSorted    = 0x00030000;

    /*! The sorting is done in reverse order.*/
    static const u_int gReverseSort     = 0x00050000;

  //@}

  //------------------------------------------------------------
  /** @name Vectors collections options */
  //@{

    /*! For vector collections, indicates that when an object is removed
     *  the other elements are moved to avoid creating holes (NULL pointers
     *  to objects).
     */
    static const u_int gShiftRemove     = 0x00100000;

    /*! For vector collections, indicates that when vector capacity is
     *  exceeded, the vector is automatically resized.
     *  It is resized only for what is required, except if gcollection::gDoubleSize
     *  bit is set.
     */
    static const u_int gAutoResize      = 0x00200000;

    /*! For vector collections, indicates that when vector capacity is
     * automatically increased, it is doubled.
     */
    static const u_int gDoubleSize      = 0x00400000;

  //@}

  //------------------------------------------------------------
  /** @name Named objects collections options */
  //@{

    /*! For named objects collections, only one object with a given name
     *  can be in the collection.*/
    static const u_int gUniqueName      = 0x01000000;

    /*! For named objects collections, the names comparison is not case
     *  sensitive.*/
    static const u_int gNoCaseSensitive = 0x02000000;

    /*! For named objects collections, the sorting is based on dictionary
     *  sorting, not on ascii codes.*/
    static const u_int gDictSort        = 0x04000000;

  //@}
}

//======================================================================
/*! \class GCollectionT
 *
 *  This is a base class for collections of objects that are instances
 *  of the class \b T.
 *  The class is abstract.
 *
 *  See \ref gcpp_templates for more information about the template classes.
 *
 */

template <class T> class GCollectionT
{
  //----------------------------------------------------------------------
  /*! \object_doc */
   GObjectV(GCollectionT<T>)
  //----------------------------------------------------------------------

  protected:
    u_int   options;        ///< Collection option flags
    u_int   count_item;     ///< Number of objects in the collection

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
  public:
    GCollectionT ( u_int flg = 0 );
    virtual ~GCollectionT ( );

  //------------------------------------------------------------
    virtual u_int GetSize    ( ) const;
    virtual u_int GetCount   ( ) const;
    virtual u_int GetOptions ( ) const;

    // option bits check
    bool  CheckOptions ( u_int opts ) const;

    // for sortable collections
    bool  FixPositionOption ( ) const;
    bool  IsSortable        ( ) const;
    bool  IsAlwaysSorted    ( ) const;
    bool  IsReverseSorted   ( ) const;

    // for named objects collections
    bool  UniqueNameOption ( ) const;
    bool  IsCaseSensitive  ( ) const;
    bool  DictSortOption   ( ) const;

    /*! Pure virtual function to empty the collection.*/
    virtual void  Empty ( ) = 0;
};

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

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