GInterval.hh

Go to the documentation of this file.

//======================================================================
/*! \file GInterval.hh
 *
 *  Include file for class GInterval that defines an interval between
 *  2 integer values (bounds included).
 */
//======================================================================

#ifndef G_INTERVAL_HH
#define G_INTERVAL_HH

#include "GGlobal.hh"
#include "GString.hh"

/*! \class GInterval
 *
 *  This class defines an interval between 2 integer values.
 *  The bounds belong to the interval.
 *  If the upper bound is smaller than the lower bound, the interval
 *  is considered empty.
 *
 */

class GInterval
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GInterval)
  //------------------------------------------------------------

  private:
    static  string  c_range;  ///< Range character identification

  protected:
    int   i_min;    ///< Interval lower bound
    int   i_max;    ///< Interval upper bound

  public:

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
    GInterval ( );                  // inline
    GInterval ( int i );            // inline
    GInterval ( int i1, int i2 );   // inline
    GInterval ( const string &s );
    GInterval ( const GInterval &original );  // inline

    virtual ~GInterval ( );         // inline

    GInterval & operator = ( const GInterval &original );

    //----------------------------------------------------------
    int     GetMin  ( ) const;  // inline
    int     GetMax  ( ) const;  // inline

    void    SetMin  ( int i );  // inline
    void    SetMax  ( int i );  // inline

    bool    IsEmpty ( ) const;  // inline

    string  GetString    ( ) const;
    string  GetStringPar ( ) const;   // inline

    int     GetValNumber ( ) const;   // inline

    //----------------------------------------------------------
    // Comparaison operator and functions
    virtual bool  operator == ( const GInterval &item );

    GInterval Overlap  ( const GInterval &inter ) const;
    bool      IsInside ( const GInterval &inter, const bool exclude = false ) const;
    bool      Contains ( const GInterval &inter, const bool exclude = false ) const;
    bool      Touches  ( const GInterval &inter ) const;

};

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

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