FilterBase.hh

Go to the documentation of this file.

//======================================================================
/*! \file FilterBase.hh
 *
 *  Fichier de déclaration de la classe de base FilterBase.
 */
//======================================================================


#ifndef FILTER_BASE_HH
#define FILTER_BASE_HH

#include "EventCommon.hh"

#include <iomanip>
using namespace std;

#include "RString.hh"

class EventManager;
class Filter;
class RContour;

/// Mode de traitement des paramètres multiples pour les filtres 1D (filtre/gate ou contour /gate)
enum FilterMultiParMode
{
  filterMultiParAnd = 0,
  filterMultiParOr  = 1
} ;

//======================================================================
/*! \class FilterBase
 *
 *  Classe de base pour les filtres sur des événements. Cette classe
 *  n'a pas vocation à être utilisée directement, mais comme un champ
 *  de la classe générique Filter.
 *
 *  Les classes dérivées définissent différents types de filtres:
 *  - les filtres constants: True, False
 *  - les filtres logiques: And, Or, XOr, Not
 *  - les filtres numériques: Gate, Contour
 */
class FilterBase
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObjectV(FilterBase);
//----------------------------------------------------------------------

  protected:

  public:

//----------------------------------------------------------------------
//  CONSTRUCTEUR / AFFECTATION / DESTRUCTEUR

    // constructeurs
    FilterBase ( );
    FilterBase ( const FilterBase & f );

    // opérateur d'affectation
    FilterBase & operator = ( const FilterBase & f );

    // destructeur
    virtual ~FilterBase ( );

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

    /*! Teste la validité du filtre.*/
    virtual bool    Ok   ( ) const = 0;

    /*! Retourne le type de filtre.*/
    virtual int     Type ( ) const = 0;

    /*! Retourne le type de filtre, sous forme textuelle.*/
    virtual string  TypeName ( ) const = 0;


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

    // Ecriture du filtre.
    virtual bool Write ( ostream &os ) const;
    virtual bool Write ( FILE *fptr ) const;

    // Fonction statique de lecture d'un nouveau filtre.
    static FilterBase * NewBase ( const string &def, const EventManager * mgr );

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

    /*! Test si un filtre utilise un contour (en particulier pour savoir si le
     *  contour peut-être effacé).
     *  \param  ct    pointeur sur le contour
     *  \param  rec   indique si on doit chercher récursivement dans les filtres
     */
    virtual bool  UsesContour ( const RContour *ct, const bool rec = true ) const = 0;

    /*! Test si un filtre utilise un autre filtre (en particulier pour savoir
     *  si le filtre peut-être effacé).
     *  \param  f     pointeur sur le filtre
     *  \param  rec   indique si on doit chercher récursivement dans les filtres
     */
    virtual bool  UsesFilter  ( const Filter *f, const bool rec = true  ) const = 0;

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

  protected:

    /*! Ecriture des données du filtre dans une chaîne de définition.*/
    virtual string DefinitionString ( ) const = 0;

//----------------------------------------------------------------------
//  pour ROOT...

  public:
    /*! Définition à usage de ROOT... */
    ClassDef(FilterBase,0);
};


//======================================================================
//  METHODES INLINE


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