SpecCumul.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecCumul.hh
 *
 *  Déclaration des méthodes de la classe SpecCumul qui décrit les
 *  spectres du cumul des traces relatifs à un paramètre de type tableau.
 */
//======================================================================

#ifndef SPEC_CUMUL_HH
#define SPEC_CUMUL_HH

#include "Spec2Dim.hh"
#include "Spec1Par.hh"
#include "ParamArray.hh"


//======================================================================
/*! \class SpecCumul
 *
 *  Classe des spectres Cumul (de traces): ce sont des spectres à 2
 *  dimensions liés à un paramètre de type tableau.
 */
class SpecCumul : public Spec2Dim, public Spec1Par
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecCumul);
//----------------------------------------------------------------------

  protected:

  public:

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

    // Constructeur
    SpecCumul ( const string & spec_name,
                const ParamArray &par,
                double x1, double x2,
                u_int ny, double y1, double y2 );

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

    // Destructeur
    virtual ~SpecCumul ();

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

  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;

    // Retourne une chaîne décrivant l'axe X du spectre.
    string YAxisDefinition ( ) 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(SpecCumul,0);
} ;


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

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

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

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

/*! Méthode qui retourne une chaîne décrivant l'axe Y du spectre
 */
inline string SpecCumul::YAxisDefinition ( ) const
  { return ( AxisDefinition (ParamX(), Ydim(), Ymin(), Ymax()) ); }


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

/*! Fonction qui renvoit le nombre de paramètres associés au spectre.
 */
inline Int_t SpecCumul::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(SpecCumul,0);
} ;


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

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

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

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

/*! Méthode qui retourne une chaîne décrivant l'axe Y du spectre
 */
inline string SpecCumul::YAxisDefinition ( ) const
  { return ( AxisDefinition (ParamX(), Ydim(), Ymin(), Ymax()) ); }


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

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


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