SpecExtern.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecExtern.hh
 *
 *  Déclaration des fonctions de la classe SpecExtern qui décrit les
 *  spectres (histogrammes) constants provenant d'un fichier ROOT.
 */
//======================================================================

#ifndef SPEC_EXTERN_HH
#define SPEC_EXTERN_HH

#include "SpecCalc.hh"


//======================================================================
/*! \class SpecExtern
 *
 *  The class is used to use ROOT histograms from ROOT files
 *  in the list of spectra.
 *  The histogram is dupplicated and cannot be modified.
 */
class SpecExtern : public SpecCalc
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecExtern);
//----------------------------------------------------------------------

  protected:
    string      file_name;      ///< Nom du fichier ROOT où est défini l'histogramme
    string      histo_name;     ///< Nom de l'histogramme dans le fichier

  public:

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

    // Constructeur
    SpecExtern ( const string & h_name,
                 const string & f_name,
                 const string & s_name );

    // Constructeur de recopie
    SpecExtern ( const SpecExtern & original );

    // Destructeur
    virtual ~SpecExtern ();

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

  public:
    virtual void    Reset     ( );

    // Retourne l'identificateur du type de spectre.
    u_int   TypeId ( ) const;

    // Retourne le nom du type de spectre.
    string  Type ( ) const;

    // Retourne une chaîne décrivant le spectre.
    virtual string      Definition ( ) const;

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

    // Définition d'un spectre de type donné    static  Spectrum  * NewSpectrumDef ( const string & name, const string & defstr, int & error );

    // Retourne le nom de l'histogramme original.
    virtual string      GetHistoName ( ) const;

    // Retourne le nom du fichier de l'histogramme original.
    virtual string      GetHistoFileName ( ) const;


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


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

/*! Remise à zéro du spectre: inopérant pour spectres calculés.*/
inline void SpecExtern::Reset ( )
  { }

/*! Retourne l'identificateur du type de spectre.
 */
inline u_int SpecExtern::TypeId ( ) const
  { return (spectrumTypeExtern); }

/*! Retourne le nom du type de spectre.
 */
inline string SpecExtern::Type ( ) const
  { return (SPECTRUM_TYPE_TXT_EXTERN); }


/*! Retourne le nom de l'histogramme original.*/
inline string SpecExtern::GetHistoName ( ) const
  { return (histo_name); }

/*! Retourne le nom du fichier de l'histogramme original.*/
inline string SpecExtern::GetHistoFileName ( ) const
  { return (file_name); }

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

    static  Spectrum  * NewSpectrumDef ( const string & name, const string & defstr, int & error );

    // Retourne le nom de l'histogramme original.
    virtual string      GetHistoName ( ) const;

    // Retourne le nom du fichier de l'histogramme original.
    virtual string      GetHistoFileName ( ) const;


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


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

/*! Remise à zéro du spectre: inopérant pour spectres calculés.*/
inline void SpecExtern::Reset ( )
  { }

/*! Retourne l'identificateur du type de spectre.
 */
inline u_int SpecExtern::TypeId ( ) const
  { return (spectrumTypeExtern); }

/*! Retourne le nom du type de spectre.
 */
inline string SpecExtern::Type ( ) const
  { return (SPECTRUM_TYPE_TXT_EXTERN); }


/*! Retourne le nom de l'histogramme original.*/
inline string SpecExtern::GetHistoName ( ) const
  { return (histo_name); }

/*! Retourne le nom du fichier de l'histogramme original.*/
inline string SpecExtern::GetHistoFileName ( ) const
  { return (file_name); }

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