RContourBase.hh

Go to the documentation of this file.

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

#ifndef R_CONTOUR_BASE_HH
#define R_CONTOUR_BASE_HH

#include "RPoint2D.hh"
#include <TObject.h>

//======================================================================
/*! \class RContourBase
 *
 *  Base class for 1D and 2D contours definition.
 */
class RContourBase
{
  //------------------------------------------------------------
  /*! \object_doc{RContourBase} */
  GObjectV(RContourBase);
  //------------------------------------------------------------

  protected:
    bool  flip_axis;      ///< Axis inversion


  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RContourBase ( );
    RContourBase ( const RContourBase & ct );

    RContourBase & operator = ( const RContourBase & ct );

    virtual ~RContourBase ( );

  //------------------------------------------------------------
    /*! Abstract function for contours comparison operators.
     *  \param  ct_ptr    contour pointer*/
    virtual bool  Compare ( const RContourBase * ct_ptr ) const = 0;

    // Contour comparison
    virtual bool operator == ( const RContourBase & ct ) const;
    virtual bool operator != ( const RContourBase & ct ) const;

  //------------------------------------------------------------

    virtual void  SetFlipAxis ( const bool flip = true );
    virtual bool  GetFlipAxis ( ) const;

  //------------------------------------------------------------
    // test contour sur un point (x,y)
    virtual bool  CheckPoint ( const Double_t x, const Double_t y ) const;

    /*! Check whether a point is inside a contour:
     *  for 2D contour, a test is performed, for 1D contour result is
     *  always false.
     *  \param  p   point to check
     */
    virtual bool  CheckPoint ( const RPoint2D &p ) const = 0;

    /*! Check whether a value is inside a 1D contour (always false for
     *  a 2D contour.
     *  \param  val   value to check
     */
    virtual bool  CheckValue ( const Double_t val ) const = 0;

    /*! Return contour dimension.*/
    virtual Int_t Dimension ( ) const = 0;

    /*! Return contour type identifier.*/
    virtual Int_t Type ( ) const = 0;

    /*! Return contour type name.*/
    virtual string TypeName ( ) const = 0;

  //------------------------------------------------------------

    // write functions.
    virtual bool Write ( ostream &os ) const;
    virtual bool Write ( FILE *fptr ) const;

    // static functions to read a contour.
    static RContourBase * ReadNew ( istream &is );
    static RContourBase * ReadNew ( FILE *fptr );

  //------------------------------------------------------------
    /*! Creation of associated ROOT objects list.*/
    virtual TList * CreateObjectList ( ) const = 0;


  protected:
    /*! Write contour data in an output C++ stream.
     *  \param  os    output C++ stream*/
    virtual bool WriteData ( ostream &os ) const = 0;

    /*! Write contour data in an output C-style file.
     *  \param  fptr  C-style file pointer*/
    virtual bool WriteData ( FILE *fptr ) const = 0;

  public:
  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RContourBase,0);
};

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

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