FilterList.hh

Go to the documentation of this file.

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


#ifndef FILTER_LIST_HH
#define FILTER_LIST_HH

#include "EventCommon.hh"

#include "Filter.hh"
#include "SpectrumList.hh"
#include "GNamedListT.hh"

#include "RContourList.hh"
#include "RPointerList.hh"

//======================================================================
/*! \class FilterList
 *
 *  Classe permettant de gérer une liste de filtres. Les filtres
 *  ajoutés sont copiés, et détruits losqu'ils sont retirés de la
 *  liste.
 *
 *  La liste de filtre sert aussi de gestionnaire d'une liste de
 *  contours.
 *
 *  La classe contient un champ correspondant à un pointeur sur un
 *  gestionnaire d'événements, afin de tester qu'un filtre n'est
 *  pas utilisé ailleurs avant d'être supprimé, et de retirer le
 *  conditionnement d'un spectre par un filtre supprimé. */

class FilterList : public GNamedListT<Filter>
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(FilterList);
//----------------------------------------------------------------------

    /// Définition du type itérateur pour les listes de filtres
    typedef GListIterT<Filter> iterator;

  protected:
    RContourList          contour_list;   ///< Liste des contours associés aux filtres

    const EventManager  * event_mgr_ptr;  ///< Pointeur sur le gestionnaire d'événement
    const Event         * event_ptr;      ///< Pointeur sur la structure d'événement du gestionnaire
    const SpectrumList  * spec_list_ptr;  ///< Pointeur sur la liste de spectres du gestionnaire

  public:

    // Constructeurs
    FilterList ( const EventManager *evt_mgr );
    FilterList ( const FilterList &original );

    // Destructeur
    virtual ~FilterList ( );

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

    virtual const RContourList * GetContourListPtr ( ) const;
    virtual       RContourList * GetContourListPtr ( );

    // Lecture / Ecriture de la liste de filtres.
    virtual Int_t   Save  ( const string & filename ) const;
    virtual Int_t   Save  ( FILE         * fptr )     const;
    virtual Int_t   Load  ( const string & filename, const bool append = true );
    virtual Int_t   Load  ( FILE         * fptr,     const bool append = true );

//----------------------------------------------------------------------
    // Fonctions de liste

    // surcharge de la fonction pour vider toujours en commençant par la
    // fin, parce qu'un filtre peut faire référence à des filtres précédents
    virtual void  Empty ( );

    // fonction surchargée parce qu'un filtre B ne peut être placé avant
    // un autre filtre A qui intervient dans la définition de B
    virtual bool  MoveUp     ( );
    virtual bool  MoveDown   ( );
    virtual bool  MoveTop    ( );
    virtual bool  MoveBottom ( );

    // teste si un des filtres de la liste utilise un contour ou un autre
    // filtre
    virtual Filter * UsesContour ( const RContour * ct, const bool rec = true ) const;
    virtual Filter * UsesFilter  ( const Filter   * f,  const bool rec = true ) const;

    // retourne des listes de pointeurs sur les filtres utilisant un
    // contour ou un autre filtre.
    virtual u_int   GetListUsingContour ( const RContour *ct, RPointerList & list ) const;
    virtual u_int   GetListUsingFilter  ( const Filter   *f,  RPointerList & list ) const;

    // retourne un numéro de filtre ou de contour
    virtual int     GetContourIndex ( const string &cname ) const;
    virtual int     GetFilterIndex  ( const string &fname ) const;

    // retire un filtre ou un contour avec vérification
    virtual bool Remove       ( );
    virtual bool RemoveFilter ( const bool force = true );
    virtual bool RemoveFilter ( const string &fname, const bool force = true );
    virtual bool RemoveFilter ( const int     fnum,  const bool force = true );
    virtual bool RemoveFilter ( Filter *fptr,  const bool force = true );

    virtual bool RemoveContour    ( const RContour *ct, const bool force = true );

    // mise à jour de tous les résultats de filtres
    virtual void UpdateValues ( ) const;

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


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

/*! Retourne le pointeur sur la liste de contours associée à la liste
 *  de filtres.*/
inline const RContourList * FilterList::GetContourListPtr ( ) const
  { return (&contour_list); }

/*! Retourne le pointeur sur la liste de contours associée à la liste
 *  de filtres.*/
inline RContourList * FilterList::GetContourListPtr ( )
  { return (&contour_list); }


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

 */

class FilterList : public GNamedListT<Filter>
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(FilterList);
//----------------------------------------------------------------------

    /// Définition du type itérateur pour les listes de filtres
    typedef GListIterT<Filter> iterator;

  protected:
    RContourList          contour_list;   ///< Liste des contours associés aux filtres

    const EventManager  * event_mgr_ptr;  ///< Pointeur sur le gestionnaire d'événement
    const Event         * event_ptr;      ///< Pointeur sur la structure d'événement du gestionnaire
    const SpectrumList  * spec_list_ptr;  ///< Pointeur sur la liste de spectres du gestionnaire

  public:

    // Constructeurs
    FilterList ( const EventManager *evt_mgr );
    FilterList ( const FilterList &original );

    // Destructeur
    virtual ~FilterList ( );

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

    virtual const RContourList * GetContourListPtr ( ) const;
    virtual       RContourList * GetContourListPtr ( );

    // Lecture / Ecriture de la liste de filtres.
    virtual Int_t   Save  ( const string & filename ) const;
    virtual Int_t   Save  ( FILE         * fptr )     const;
    virtual Int_t   Load  ( const string & filename, const bool append = true );
    virtual Int_t   Load  ( FILE         * fptr,     const bool append = true );

//----------------------------------------------------------------------
    // Fonctions de liste

    // surcharge de la fonction pour vider toujours en commençant par la
    // fin, parce qu'un filtre peut faire référence à des filtres précédents
    virtual void  Empty ( );

    // fonction surchargée parce qu'un filtre B ne peut être placé avant
    // un autre filtre A qui intervient dans la définition de B
    virtual bool  MoveUp     ( );
    virtual bool  MoveDown   ( );
    virtual bool  MoveTop    ( );
    virtual bool  MoveBottom ( );

    // teste si un des filtres de la liste utilise un contour ou un autre
    // filtre
    virtual Filter * UsesContour ( const RContour * ct, const bool rec = true ) const;
    virtual Filter * UsesFilter  ( const Filter   * f,  const bool rec = true ) const;

    // retourne des listes de pointeurs sur les filtres utilisant un
    // contour ou un autre filtre.
    virtual u_int   GetListUsingContour ( const RContour *ct, RPointerList & list ) const;
    virtual u_int   GetListUsingFilter  ( const Filter   *f,  RPointerList & list ) const;

    // retourne un numéro de filtre ou de contour
    virtual int     GetContourIndex ( const string &cname ) const;
    virtual int     GetFilterIndex  ( const string &fname ) const;

    // retire un filtre ou un contour avec vérification
    virtual bool Remove       ( );
    virtual bool RemoveFilter ( const bool force = true );
    virtual bool RemoveFilter ( const string &fname, const bool force = true );
    virtual bool RemoveFilter ( const int     fnum,  const bool force = true );
    virtual bool RemoveFilter ( Filter *fptr,  const bool force = true );

    virtual bool RemoveContour    ( const RContour *ct, const bool force = true );

    // mise à jour de tous les résultats de filtres
    virtual void UpdateValues ( ) const;

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


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

/*! Retourne le pointeur sur la liste de contours associée à la liste
 *  de filtres.*/
inline const RContourList * FilterList::GetContourListPtr ( ) const
  { return (&contour_list); }

/*! Retourne le pointeur sur la liste de contours associée à la liste
 *  de filtres.*/
inline RContourList * FilterList::GetContourListPtr ( )
  { return (&contour_list); }


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