SpectrumFamilyList.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpectrumFamilyList.hh
 *
 *  Déclaration des méthodes de la classe SpectrumFamilyList qui définit
 *  une liste de familles de spectres.
 */
//======================================================================

#include "EventCommon.hh"
#include "GNamedListT.hh"
#include "SpectrumFamily.hh"

#ifndef SPECTRUM_FAMILY_LIST_HH
#define SPECTRUM_FAMILY_LIST_HH

class SpectrumList;

//======================================================================
/*! \class SpectrumFamilyList
 *
 *  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.
 */
class SpectrumFamilyList : public GNamedListT<SpectrumFamily>
{
  friend class SpectrumList;

//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpectrumFamilyList);
//----------------------------------------------------------------------

  protected:
    const SpectrumList   *manager;  ///< Gestionnaire auquel est associée la liste de familles

  public:

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

    // Constructeur par défaut.
    SpectrumFamilyList ( const SpectrumList * spec_manager = NULL );

    // Destructeur
    virtual ~SpectrumFamilyList ( );

    // Constructeur de recopie.
  protected:
    SpectrumFamilyList ( const SpectrumFamilyList & );


  protected:
    // Recherche d'une famille (protégé)
    SpectrumFamily  * __FindFamily ( const string &family_name ) const;

  public:
    // Recherche d'une famille
    const SpectrumFamily  *FindFamily ( const string &family_name ) const;

    // Place un spectre dans une famille
    bool  SetSpectrumFamily ( Spectrum * spec, const string & family_name );

    // Retire un spectre d'une famille
    bool  ResetSpectrumFamily ( Spectrum *spec );


    // écriture de la liste des familles
    void  Print () const;
    void  Print ( const string & file_name ) const;
    void  Print ( ostream &os ) const;

    // écriture d'une famille de la liste
    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;

    // état de sélection des spectres d'une famille
    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;

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


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

/*! Ecriture des familles de spectres sur la sortie standard.
 */
inline void SpectrumFamilyList::Print () const
  { Print (cout); }

/*! Ecriture d'une famille de spectres sur la sortie standard.
 *  \param    family_name   nom de la famille ("" pour toutes les familles)
 */
inline void SpectrumFamilyList::PrintFamily ( const string & family_name ) const
  { PrintFamily (cout,family_name); }

//======================================================================

#endif