Analysis  version 7.0 - august 2014
FilterList Class Reference

#include <FilterList.hh>

Inheritance diagram for FilterList:

Public Member Functions

 FilterList (const EventManager *evt_mgr)
 
 FilterList (const FilterList &original)
 
virtual ~FilterList ()
 
virtual const RContourList * GetContourListPtr () const
 
virtual RContourList * GetContourListPtr ()
 
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)
 
virtual void Empty ()
 
virtual bool MoveUp ()
 
virtual bool MoveDown ()
 
virtual bool MoveTop ()
 
virtual bool MoveBottom ()
 
virtual FilterUsesContour (const RContour *ct, const bool rec=true) const
 
virtual FilterUsesFilter (const Filter *f, const bool rec=true) const
 
virtual u_int GetListUsingContour (const RContour *ct, RPointerList &list) const
 
virtual u_int GetListUsingFilter (const Filter *f, RPointerList &list) const
 
virtual int GetContourIndex (const string &cname) const
 
virtual int GetFilterIndex (const string &fname) const
 
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)
 
virtual void UpdateValues () const
 
 ClassDef (FilterList, 0)
 

Protected Attributes

RContourList contour_list
 Liste des contours associés aux filtres.
 
const EventManagerevent_mgr_ptr
 Pointeur sur le gestionnaire d'événement.
 
const Eventevent_ptr
 Pointeur sur la structure d'événement du gestionnaire.
 
const SpectrumListspec_list_ptr
 Pointeur sur la liste de spectres du gestionnaire.
 

Private Types

typedef GListIterT< Filteriterator
 Définition du type itérateur pour les listes de filtres.
 

Private Member Functions

 GObject (FilterList)
 

Detailed Description

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é.

Constructor & Destructor Documentation

FilterList::FilterList ( const EventManager evt_mgr)

Constructeur par défaut.

Parameters
evt_mgrpointeur sur le gestionnaire d'événements

References event_mgr_ptr, event_ptr, EventManager::GetEventPtr(), EventManager::GetSpectrumListPtr(), and spec_list_ptr.

FilterList::FilterList ( const FilterList original)

Constructeur de recopie.

Parameters
originalinstance à recopier

References event_mgr_ptr, event_ptr, and spec_list_ptr.

FilterList::~FilterList ( )
virtual

Destructeur: la liste est vidée par la classe de base GListT.

References contour_list, and Empty().

Member Function Documentation

FilterList::GObject ( FilterList  )
private

Macro from GCpp library that defines the following functions:

  • ClassName(): return the real class name of the object
  • StaticClassName(): return the used class name of the object (that may be a base class of the real object).
  • IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
  • Clone(): return an allocated copy of the object.
const RContourList * FilterList::GetContourListPtr ( ) const
inlinevirtual
RContourList * FilterList::GetContourListPtr ( )
inlinevirtual

Retourne le pointeur sur la liste de contours associée à la liste de filtres.

References contour_list.

Int_t FilterList::Save ( const string &  filename) const
virtual

Ecriture d'une liste de filtre dans un fichier. La valeur en retour est le nombre de fichiers écrits, ou -1 en cas d'erreur.

Parameters
filenamenom du fichier

Referenced by GEVFilterEditor::SaveAll(), and EventManager::SaveFilterList().

Int_t FilterList::Save ( FILE *  fptr) const
virtual

Ecriture d'une liste de filtres dans un fichier. Le fichier doit être déjà ouvert, et n'est pas fermé en fin d'écriture. La valeur en retour indique le nombre de filtres écrits, ou -1 en cas d'erreur.

Parameters
fptrpointeur sur le fichier
Int_t FilterList::Load ( const string &  filename,
const bool  append = true 
)
virtual

Lecture d'une liste de filtres dans un fichier. La valeur en retour est le nombre de filtres lus, ou -1 en cas d'erreur.

Parameters
filenamenom du fichier
appendindique s'il faut ajouter les filtres à la liste ou la recréer

Referenced by GEVFilterEditor::Load(), and EventManager::LoadFilterList().

Int_t FilterList::Load ( FILE *  fptr,
const bool  append = true 
)
virtual

Lecture d'une liste de filtres dans un fichier. La valeur en retour est le nombre de filtres lus, ou -1 en cas d'erreur. Le fichier doit être déjà ouvert, et n'est pas fermé en fin de lecture.

Parameters
fptrpointeur sur le fichier
appendindique s'il faut ajouter les filtres à la liste ou la recréer

References Empty(), event_mgr_ptr, and Filter::Read().

void FilterList::Empty ( )
virtual

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.

Referenced by Load(), TreeList::Load(), EventManager::~EventManager(), ~FilterList(), SpectrumFamily::~SpectrumFamily(), and TreeList::~TreeList().

bool FilterList::MoveUp ( )
virtual

Déplace un filtre d'un rang vers le début de la liste. Cette fonction n'est autorisée que si le filtre déplacé n'utilise pas le filtre précédent dans sa définition.

References Filter::UsesFilter().

Referenced by GEVFilterEditor::Done(), and GEVFilterEditor::SelectionMoved().

bool FilterList::MoveDown ( )
virtual

Déplace un filtre d'un rang vers la fin de la liste. Cette fonction n'est autorisée que si le filtre suivant n'utilise pas le filtre déplacé dans sa définition.

References Filter::UsesFilter().

bool FilterList::MoveTop ( )
virtual

Déplace un filtre en début de liste. Cette fonction n'est autorisée que si le filtre déplacé n'utilise aucun des filtres précédents dans sa définition.

References Filter::UsesFilter().

Referenced by GEVFilterEditor::Done(), and GEVFilterEditor::SelectionMoved().

bool FilterList::MoveBottom ( )
virtual

Déplace un filtre en fin de liste. Cette fonction n'est autorisée que si aucun des filtres suivants n'utilise le filtre déplacé dans sa définition.

References Filter::UsesFilter().

Filter * FilterList::UsesContour ( const RContour *  ct,
const bool  rec = true 
) const
virtual

Teste si un des filtres de la liste utilise contour. Si un filtre est trouvé, son pointeur est retourné.

Parameters
ctpointeur sur le contour dont on cherche l'utilisation
recindique si on doit chercher récursivement dans les filtres

Referenced by EventManager::LoadContourList(), and RemoveContour().

Filter * FilterList::UsesFilter ( const Filter f,
const bool  rec = true 
) const
virtual

Teste si un des filtres de la liste utilise un autre filtre. Si un filtre est trouvé, son pointeur est retourné.

Parameters
fpointeur sur le filtre dont on cherche l'utilisation
recindique si on doit chercher récursivement dans les filtres

Referenced by Remove(), and RemoveFilter().

u_int FilterList::GetListUsingContour ( const RContour *  ct,
RPointerList &  list 
) const
virtual

Retourne le nombre de filtres qui utilisent le contour passé en argument dans leur définition. Une liste de pointeurs sur les filtres est retournée.

Parameters
ctpointeur sur le contour cherché
listliste en retour des pointeurs sur les filtres trouvés

Referenced by GEVContourEditor::Delete(), and RemoveContour().

u_int FilterList::GetListUsingFilter ( const Filter f,
RPointerList &  list 
) const
virtual

Retourne le nombre de filtres qui utilisent le filtre passé en argument dans leur définition. Une liste de pointeurs sur les filtres est retournée.

Parameters
fpointeur sur le filtre cherché
listliste en retour des pointeurs sur les filtres trouvés

Referenced by GEVFilterEditor::Delete(), and RemoveFilter().

int FilterList::GetContourIndex ( const string &  cname) const
virtual

Retourne le numéro d'un contour de la liste, ou -1 si le contour n'existe pas.

Parameters
cnamenom du contour recherché

References GetContourListPtr().

int FilterList::GetFilterIndex ( const string &  fname) const
virtual

Retourne le numéro d'un filtre de la liste, ou -1 si le contour n'existe pas.

Parameters
fnamenom du filtre recherché
bool FilterList::Remove ( )
virtual

Retire un filtre de la liste, en vérifiant au préalable qu'il n'est pas utilisé par les autres filtres de la liste ou par les spectres. Si c'est le cas, les autres filtres sont supprimés et le filtrage est retiré des spectres.

References RemoveFilter(), spec_list_ptr, and UsesFilter().

Referenced by RemoveFilter().

bool FilterList::RemoveFilter ( const bool  force = true)
virtual

Retire le filtre courant de la liste, en vérifiant au préalable s'il est utilisé par les autres filtres de la liste ou par les spectres.

Parameters
forceindique s'il faut forcer la suppression des filtres utilisant celui qui est supprimé

References GetListUsingFilter(), SpectrumList::GetListUsingFilter(), Remove(), spec_list_ptr, UsesFilter(), and SpectrumList::UsesFilter().

Referenced by GEVFilterEditor::Delete(), Remove(), RemoveContour(), RemoveFilter(), and EventManager::RemoveFilter().

bool FilterList::RemoveFilter ( const string &  fname,
const bool  force = true 
)
virtual

Retire un filtre de la liste, en vérifiant au préalable s'il est utilisé par les autres filtres de la liste ou par les spectres.

Parameters
fnamenom du filtre à supprimer
forceindique s'il faut forcer la suppression des filtres utilisant celui qui est supprimé

References RemoveFilter().

bool FilterList::RemoveFilter ( const int  fnum,
const bool  force = true 
)
virtual

Retire un filtre de la liste, en vérifiant au préalable s'il est utilisé par les autres filtres de la liste ou par les spectres.

Parameters
fnumnuméro du filtre à supprimer
forceindique s'il faut forcer la suppression des filtres utilisant celui qui est supprimé

References RemoveFilter().

bool FilterList::RemoveFilter ( Filter fptr,
const bool  force = true 
)
virtual

Retire un filtre de la liste, en vérifiant au préalable s'il est utilisé par les autres filtres de la liste ou par les spectres.

Parameters
fptrpointeur sur le filtre à supprimer
forceindique s'il faut forcer la suppression des filtres utilisant celui qui est supprimé

References RemoveFilter().

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

Retire un contour de la liste, en vérifiant au préalable qu'il n'est pas utilisé par les filtres de la liste.

Parameters
ctpointeur sur le contour à retirer
forceindique s'il faut forcer la suppression des filtres utilisant le contour à supprimer

References contour_list, GetListUsingContour(), SpectrumList::GetListUsingContour(), RemoveFilter(), spec_list_ptr, UsesContour(), and SpectrumList::UsesContour().

Referenced by EventManager::RemoveContour().

void FilterList::UpdateValues ( ) const
virtual

Fonction qui met à jour tous les résultats de filtres: en principe, elle est à usage interne, avant incrémentation automatique des spectres, mais elle peut être utilisée en externe.

Referenced by EventManager::IncrementSpectra().

FilterList::ClassDef ( FilterList  ,
 
)

Définition à usage de ROOT...


The documentation for this class was generated from the following files: