FilterBaseFalse.hh

Go to the documentation of this file.

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

#ifndef FILTER_BASE_FALSE_HH
#define FILTER_BASE_FALSE_HH

#include "FilterBase.hh"
#include "Filter.hh"

//======================================================================
/*! \class FilterBaseFalse
 *
 *  Classe des filtres toujours faux. Son seul intérêt peut résider
 *  dans la modification d'un filtre existant.
 *
 *  \note
 *    cette classe n'a pas besoin de la fonction statique ReadNew,
 *    puisqu'elle ne contient pas d'information.
 */
class FilterBaseFalse : public FilterBase
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(FilterBaseFalse);
//----------------------------------------------------------------------

  protected:

  public:

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

    // constructeur
    FilterBaseFalse ( );

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

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

    // destructeur
    virtual ~FilterBaseFalse ( );

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

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

    // 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;

  protected:


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

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


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

/*! Test de validité du filtre.
 */
inline bool FilterBaseFalse::Ok ( ) const
  { return ( false ); }

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

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

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

/*! 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 FilterBaseFalse::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é).
 *  \param  f     pointeur sur le filtre
 *  \param  rec   indique si on doit chercher récursivement dans les filtres
 */
inline bool FilterBaseFalse::UsesFilter ( const Filter *f, const bool rec ) const
  { return ( false ); }

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