SpecMono.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecMono.hh
 *
 *  Déclaration des méthodes de la classe SpecMono qui décrit les
 *  spectres simples relatifs à un paramètre.
 */
//======================================================================

#ifndef SPEC_MONO_HH
#define SPEC_MONO_HH

#include "Spec1Dim.hh"
#include "Spec1Par.hh"

//======================================================================
/*! \class SpecMono
 *
 *  Classe des spectres à 1 dimension, relatifs à un paramètre simple.
 */
class SpecMono : public Spec1Dim, public Spec1Par
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecMono);
//----------------------------------------------------------------------

  protected:

  public:

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

    // Constructeur
    SpecMono ( const string & spec_name,
               const Param &par,
               const u_int nx, const double x1, const double x2 );

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

    // Destructeur
    virtual ~SpecMono ();

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

  protected:

    // incrémentation auto du spectre
    virtual void IncrementSpectrum ( );

  public:

    // 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;

    // Retourne une chaîne décrivant l'axe X du spectre.
    string XAxisDefinition ( ) const;

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

    // renvoit le pointeur sur le paramètre X du spectre.
    virtual const Param * GetXParamPtr ( ) const;

    // renvoit le nombre de paramètres associés au spectre.
    virtual Int_t         GetParamNumber ( ) const;

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

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


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

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

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

/*! Fonction qui retourne une chaîne décrivant l'axe X du spectre
 */
inline string SpecMono::XAxisDefinition ( ) const
  { return ( AxisDefinition (ParamX(), Xdim(), Xmin(), Xmax()) ); }


/*! Fonction qui renvoit le pointeur sur le paramètre X du spectre.
 */
inline const Param * SpecMono::GetXParamPtr ( ) const
  { return ( Spec1Par::GetXParamPtr() ); }

/*! Fonction qui renvoit le nombre de paramètres associés au spectre.
 */
inline Int_t SpecMono::GetParamNumber ( ) const
  { return (Spec1Par::GetParamNumber()); }


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

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

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


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

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

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

/*! Fonction qui retourne une chaîne décrivant l'axe X du spectre
 */
inline string SpecMono::XAxisDefinition ( ) const
  { return ( AxisDefinition (ParamX(), Xdim(), Xmin(), Xmax()) ); }


/*! Fonction qui renvoit le pointeur sur le paramètre X du spectre.
 */
inline const Param * SpecMono::GetXParamPtr ( ) const
  { return ( Spec1Par::GetXParamPtr() ); }

/*! Fonction qui renvoit le nombre de paramètres associés au spectre.
 */
inline Int_t SpecMono::GetParamNumber ( ) const
  { return (Spec1Par::GetParamNumber()); }


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