FilterBaseContour.hh

Go to the documentation of this file.

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

#ifndef FILTER_BASE_CONTOUR_HH
#define FILTER_BASE_CONTOUR_HH

#include "FilterBase.hh"
#include "FilterList.hh"
#include "RContourList.hh"
#include "Event.hh"

//======================================================================
/*! \class FilterBaseContour
 *
 *  Classe des filtres testant un contour sur 1 (Gate) ou 2 paramètres.
 *  Dans le cas d'un contour à 1 paramètre, les paramètres de type
 *  ParamArray ou ParamMultihit peuvent être testés en mode ET ou en
 *  mode OU.
 *  Pour des filtres avec des contours 2D sur ce type de paramètres, le
 *  résultat est toujours faux.
 */
class FilterBaseContour : public FilterBase
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(FilterBaseContour);
//----------------------------------------------------------------------

  protected:
    const RContour * contour;     ///< Contour associé au filtre
    const Param    * par_x;       ///< Paramètre X pour test du contour
    const Param    * par_y;       ///< Paramètre Y pour test du contour
    bool             invert;      ///< Définit si le filtre est inversé
    int              mode_multi;  ///< Mode de traitement des paramètres multiples

  public:

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

    // constructeur
    FilterBaseContour ( const RContour * ctr, const Param * px, const Param * py, const bool inv = false, const int mode = filterMultiParAnd );
    FilterBaseContour ( const RContour * ctr, const Param * px, const bool inv = false, const int mode = filterMultiParAnd );

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

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

    // destructeur
    virtual ~FilterBaseContour ( );

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

    // 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 contour, et l'événement dans lequel sont les paramètres
    static FilterBaseContour * 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 RContour  * GetContourPtr ( ) const;
    virtual const Param     * GetXParamPtr  ( ) const;
    virtual const Param     * GetYParamPtr  ( ) const;
    virtual bool              GetInvert     ( ) const;
    virtual int               GetModeMulti  ( ) const;

  protected:


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

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


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

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

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

/*! Retourne le pointeur sur le contour. */
inline const RContour * FilterBaseContour::GetContourPtr ( ) const
  { return (contour); }

/*! Retourne le pointeur sur le paramètre X. */
inline const Param * FilterBaseContour::GetXParamPtr ( ) const
  { return (par_x); }

/*! Retourne le pointeur sur le paramètre Y. */
inline const Param * FilterBaseContour::GetYParamPtr ( ) const
  { return (par_y); }

/*! Retourne l'état d'inversion d'appartenance du contour. */
inline bool FilterBaseContour::GetInvert ( ) const
  { return (invert); }

/*! Retourne le mode de traitement des paramètres multiples. */
inline int FilterBaseContour::GetModeMulti ( ) const
  { return (mode_multi); }

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

/*! 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
 */
inline bool FilterBaseContour::UsesContour ( const RContour *ct, const bool rec ) const
  { return ( (contour != NULL) && (contour == ct) ); }

/*! 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
 */
inline bool FilterBaseContour::UsesFilter ( const Filter *f, const bool rec ) const
  { return ( false ); }


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