GIntervalList.hh

Go to the documentation of this file.

//======================================================================
/*! \file GIntervalList.hh
 *
 *  Include file for class GIntervalList.
 */
//======================================================================

#ifndef G_INTERVAL_LIST_HH
#define G_INTERVAL_LIST_HH

#include "GInterval.hh"
#include "GListT.hh"

//======================================================================
/*! \class GIntervalList
 *
 *  This class defines a list of intervals of integer values.
 *
 *  The base class is protected since adding and removing intervals
 *  is done with a check of overlapping intervals.
 *
 *  The class defines an index to navigate from one value to the next
 *  (and not only from one interval to the next, as the base class do).
 *
 */

class GIntervalList : protected GListT<GInterval>
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GIntervalList)
//----------------------------------------------------------------------

    using GListT<GInterval>::Begin;
    using GListT<GInterval>::End;
    using GListT<GInterval>::Null;
    using GListT<GInterval>::First;
    using GListT<GInterval>::Last;
    using GListT<GInterval>::Next;
    using GListT<GInterval>::Previous;
    using GListT<GInterval>::Current;
    using GListT<GInterval>::GetSize;
    using GListT<GInterval>::Empty;

    static  const int noMin;    ///< Undefined minimu value
    static  const int noMax;    ///< Undefined maximum value

    static  string    c_separ;  ///< Elements separation characters

    /// Defines locally the iterator type
    typedef GListIterT<GInterval> iterator;

  protected:
    int   * index_ptr;      ///< Pointer of the index (so that the value can be modified for a constant list)

  public:
  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation

    GIntervalList ( );
    GIntervalList ( const string        & str );
    GIntervalList ( const GIntervalList & original );

    virtual ~GIntervalList ( );

    GIntervalList & operator = ( const GIntervalList &original );

  //------------------------------------------------------------
    virtual string  GetString    ( ) const;
    virtual string  GetStringPar ( ) const;

    int   GetMinValue  ( ) const;
    int   GetMaxValue  ( ) const;
    int   GetValNumber ( ) const;
    int * GetArray     ( int & len ) const;

    bool  Contains     ( int val ) const;

  //------------------------------------------------------------
  // Loop on values
    int   FromFirst   ( ) const;
    int   ToLast      ( ) const;
    int   NextVal     ( ) const;

    int   FromLast    ( ) const;
    int   ToFirst     ( ) const;
    int   PreviousVal ( ) const;

  //------------------------------------------------------------
    // List functions
    virtual GListIterT<GInterval>  Add ( const GInterval & inter );
    virtual GListIterT<GInterval>  Add ( const string    & s );
    virtual GListIterT<GInterval>  Add ( int i );
    virtual GListIterT<GInterval>  Add ( int i1, int i2 );

    virtual bool  Remove ( const GInterval & inter );
    virtual bool  Remove ( const string    & s );
    virtual bool  Remove ( int i );
    virtual bool  Remove ( int i1, int i2 );

  //------------------------------------------------------------
    // hidden functions from the base class
  protected:
    // fonctions "cachées" de la classe de base
    virtual bool  Remove ( );
    virtual bool  Remove (  const GInterval * ptr, bool all = true );
};

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

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