SpectrumFamilyList Class Reference

#include <SpectrumFamilyList.hh>

Inheritance diagram for SpectrumFamilyList:

Public Member Functions
	SpectrumFamilyList (const SpectrumList *spec_manager=NULL)
virtual	~SpectrumFamilyList ()
const SpectrumFamily *	FindFamily (const string &family_name) const
bool	SetSpectrumFamily (Spectrum *spec, const string &family_name)
bool	ResetSpectrumFamily (Spectrum *spec)
void	Print () const
void	Print (const string &file_name) const
void	Print (ostream &os) const
void	PrintFamily (const string &family_name) const
void	PrintFamily (const string &file_name, const string &family_name) const
void	PrintFamily (ostream &os, const string &family_name) const
virtual bool	SetSpectraSelection (const string &family_name, const bool b=true) const
virtual bool	SetSpectraSaveSelection (const string &family_name, const bool b=true) const
virtual bool	SetSpectraDeleteSelection (const string &family_name, const bool b=true) const
	ClassDef (SpectrumFamilyList, 0)

Protected Member Functions
	SpectrumFamilyList (const SpectrumFamilyList &)
SpectrumFamily *	__FindFamily (const string &family_name) const

Protected Attributes
const SpectrumList *	manager
	Gestionnaire auquel est associée la liste de familles.

Private Member Functions
	GObject (SpectrumFamilyList)

Friends
class	SpectrumList

Detailed Description

Cette classe décrit un ensemble de familles de spectres. Cette classe gère les familles: elle recopie les familles ajoutées et les détruits lorsqu'elles sont retirées.

Une famille est créée lorsqu'un premier spectre y est mis. Elle est retiré lorsqu'elle ne contient plus de spectre.

Constructor & Destructor Documentation

SpectrumFamilyList::SpectrumFamilyList

(

const SpectrumList *

spec_manager = NULL

)

Constructeur par défaut: crée une liste vide.

References manager.

SpectrumFamilyList::~SpectrumFamilyList ( )

virtual

Destructeur.

SpectrumFamilyList::SpectrumFamilyList ( const SpectrumFamilyList &  original )

protected

Constructeur de recopie: il ne devrait pas être utilisé: il recréée les familles, mais pas leur contenu (au cas où la copie irait vers un autre gestionnaire de spectres SpectrumList).

Parameters

original

instance à recopier

References manager.

Member Function Documentation

SpectrumFamilyList::GObject ( SpectrumFamilyList  )

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.

SpectrumFamily * SpectrumFamilyList::__FindFamily ( const string &  family_name ) const

protected

Recherche une famille par son nom et renvoie son pointeur (ou NULL si la famille n'est pas trouvée dans la liste). La méthode est protégée car elle retourne un pointeur sur un objet qui n'est pas constant.

Parameters

family_name

nom de la famille

Referenced by FindFamily(), ResetSpectrumFamily(), and SetSpectrumFamily().

const SpectrumFamily * SpectrumFamilyList::FindFamily

(

const string &

family_name

)

const

Recherche une famille par son nom et renvoie son pointeur (ou NULL si la famille n'est pas trouvée dans la liste).

Parameters

family_name

nom de la famille

References __FindFamily().

Referenced by PrintFamily(), SpectrumList::ResetFamily(), SpectrumList::ResetFamilyFilter(), SpectrumList::SaveFamilyHistograms(), SpectrumList::SetFamilyFilter(), SetSpectraDeleteSelection(), SetSpectraSaveSelection(), SetSpectraSelection(), SpectrumList::StartFamily(), SpectrumList::StopFamily(), and SpectrumList::SuspendFamily().

bool SpectrumFamilyList::SetSpectrumFamily	(	Spectrum *	spec,
		const string &	family_name
	)

Place un spectre dans une famille: la méthode retourne vrai si le pointeur de spectre n'est pas NULL, s'il n'est pas déjà dans une famille et si le nom de la famille est valide. Si la famille n'existe pas, elle est crée.

Parameters

spec	pointeur sur le spectre à mettre dans la famille
family_name	nom de la famille

References __FindFamily(), and SpectrumFamily::AddSpectrum().

Referenced by SpectrumList::SetSpectrumFamily().

bool SpectrumFamilyList::ResetSpectrumFamily

(

Spectrum *

spec

)

Retire un spectre de sa famille: c'est effectif si le spectre appartient à la liste et qu'il est dans une famille. Si la famille n'existe pas, elle est crée.

Parameters

spec	pointeur sur le spectre à mettre dans la famille

References __FindFamily(), Spectrum::GetFamilyName(), and SpectrumFamily::RemoveSpectrum().

Referenced by SpectrumList::ResetSpectrumFamily().

void SpectrumFamilyList::Print ( ) const

inline

Ecriture des familles de spectres sur la sortie standard.

Referenced by Print(), and PrintFamily().

void SpectrumFamilyList::Print

(

const string &

file_name

)

const

Ecriture des familles de spectres dans un fichier.

Parameters

file_name

nom du fichier

References Print().

void SpectrumFamilyList::Print

(

ostream &

os

)

const

Ecriture des familles de spectres dans un flux de sortie.

Parameters

os	flux de sortie

void SpectrumFamilyList::PrintFamily ( const string &  family_name ) const

inline

Ecriture d'une famille de spectres sur la sortie standard.

Parameters

family_name

nom de la famille ("" pour toutes les familles)

Referenced by PrintFamily(), and SpectrumList::PrintFamily().

void SpectrumFamilyList::PrintFamily	(	const string &	file_name,
		const string &	family_name
	)		const

Ecriture d'une famille de spectres dans un fichier.

Parameters

file_name	nom du fichier
family_name	nom de la famille ("" pour toutes les familles)

References Print(), and PrintFamily().

void SpectrumFamilyList::PrintFamily	(	ostream &	os,
		const string &	family_name
	)		const

Ecriture d'une famille de spectres dans un flux de sortie.

Parameters

os	flux de sortie
family_name	nom de la famille ("" pour toutes les familles)

References FindFamily(), and Print().

bool SpectrumFamilyList::SetSpectraSelection ( const string &  family_name, const bool  b = true  ) const

virtual

Définition de l'état de sélection des spectres d'une famille. La fonction retourne vrai si la famille existe.

Parameters

family_name	nom de la famille
b	état de sélection demandé

References FindFamily().

Referenced by SpectrumList::SetFamilySelection().

bool SpectrumFamilyList::SetSpectraSaveSelection ( const string &  family_name, const bool  b = true  ) const

virtual

Définition de l'état de sélection pour sauvegarde des spectres d'une famille. La fonction retourne vrai si la famille existe.

Parameters

family_name	nom de la famille
b	état de sélection demandé

References FindFamily().

Referenced by SpectrumList::SetFamilySaveSelection().

bool SpectrumFamilyList::SetSpectraDeleteSelection ( const string &  family_name, const bool  b = true  ) const

virtual

Définition de l'état de sélection pour suppression des spectres d'une famille. La fonction retourne vrai si la famille existe.

Parameters

family_name	nom de la famille
b	état de sélection demandé

References FindFamily().

Referenced by SpectrumList::SetFamilyDeleteSelection().

SpectrumFamilyList::ClassDef	(	SpectrumFamilyList	,
		0
	)

Définition à usage de ROOT...

---

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

• SpectrumFamilyList.hh
• SpectrumFamilyList.cpp