FilterBaseGate.hh

Go to the documentation of this file.

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

#ifndef FILTER_BASE_GATE_HH
#define FILTER_BASE_GATE_HH

#include "FilterBase.hh"
#include "FilterList.hh"

//======================================================================
/*! \class FilterBaseGate
 *
 *  Classe des données des filtres de type porte: paramètre compris
 *  entre 2 valeurs.
 *
 *  Dans le cas de paramètres multiples (tableaux, multihit), le filtre
 *  peut être valide soit en mode ET (toutes les valeurs dans la porte),
 *  soit en mode OU (au moins une valeur dans la porte).
 *  Ce mode est défini par la variable \b mode_multi.
 */
class FilterBaseGate : public FilterBase
{
//----------------------------------------------------------------------
  /*! \object_doc} */
  GObject(FilterBaseGate);
//----------------------------------------------------------------------

  protected:
    const Param   * par;        ///< Paramètre sur lequel est testée la porte
    double          par_min;    ///< Borne inférieure de la porte
    double          par_max;    ///< Borne supérieure de la porte

    int             mode_multi; ///< Mode de traitement des paramètres multiples

  public:

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

    // constructeur
    FilterBaseGate ( const Param * p, const double pmin, const double pmax, const int mode = filterMultiParAnd );

    // constructeur de recopie
    FilterBaseGate ( const FilterBaseGate & f );

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

    // destructeur
    virtual ~FilterBaseGate ( );

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

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

    // Fonction statique de lecture d'un nouveau filtre.
    //  il faut passer une liste en argument, dans laquelle doit
    //  se trouver le filtre dont on veut la négation
    static FilterBaseGate * NewBase ( const string &def, const EventManager * mgr );

    // test si un filtre utilise un contour ou un autre filtre
    // pour vérifier qu'il peut être effacé dans les listes.
    virtual bool  UsesContour ( const RContour *ct, const bool rec = true ) const;
    virtual bool  UsesFilter  ( const Filter   *f,  const bool rec = true ) const;

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

    virtual bool            Ok            ( ) const;
    virtual int             Type          ( ) const;
    virtual string          TypeName      ( ) const;
    virtual const Param  *  GetParamPtr   ( ) const;
    virtual double          GetMin        ( ) const;
    virtual double          GetMax        ( ) const;

  protected:


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


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

/*! Retourne le type de filtre. */
inline int FilterBaseGate::Type ( ) const
  { return (Filter::typeGate); }

/*! Retourne le type de filtre, sous forme textuelle. */
inline string FilterBaseGate::TypeName ( ) const
  { return (FILTER_TYPE_TXT_GATE); }

/*! Retourne le pointeur sur le paramètre associé au filtre. */
inline const Param * FilterBaseGate::GetParamPtr ( ) const
  { return (par); }

/*! Retourne le la borne inférieure de la porte. */
inline double FilterBaseGate::GetMin ( ) const
  { return (par_min); }

/*! Retourne le la borne supérieure de la porte. */
inline double FilterBaseGate::GetMax ( ) const
  { return (par_max); }

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

/*! Test si un filtre utilise un contour (en particulier pour savoir si le
 *  contour peut-être effacé):
 *  toujours faux pour ce type de filtre.
 *  \param  ct    pointeur sur le contour
 *  \param  rec   indique si on doit chercher récursivement dans les filtres
 */
inline bool FilterBaseGate::UsesContour ( const RContour *ct, const bool rec ) const
  { return ( false ); }

/*! Test si un filtre utilise un autre filtre (en particulier pour savoir
 *  si le filtre peut-être effacé):
 *  toujours faux pour ce type de filtre.
 *  \param  f     pointeur sur le filtre
 *  \param  rec   indique si on doit chercher récursivement dans les filtres
 */
inline bool FilterBaseGate::UsesFilter ( const Filter *f, const bool rec ) const
  { return ( false ); }


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