SpecBidim.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecBidim.hh
 *
 *  Déclaration des méthodes de la classe SpecBidim qui décrit les
 *  spectres bidimensionnels relatifs à deux paramètres.
 */
//======================================================================

#ifndef SPEC_BIDIM_HH
#define SPEC_BIDIM_HH

#include "Spec2Dim.hh"
#include "Spec2Par.hh"


//======================================================================
/*! \class SpecBidim
 *
 *  Classe des spectres à 2 dimensions, relatifs à deux paramètres simples.
 */
class SpecBidim : public Spec2Dim, public Spec2Par
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecBidim);
//----------------------------------------------------------------------

  protected:

  public:

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

    // Constructeur
    SpecBidim ( const string & spec_name,
                const Param &par_x,
                const u_int nx, const double x1, const double x2,
                const Param &par_y,
                const u_int ny, const double y1, const double y2 );

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

    // Destructeur
    virtual ~SpecBidim ();

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

  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 Y 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 pointeur sur le paramètre Y du spectre.
    virtual const Param * GetYParamPtr ( ) 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(SpecBidim,0);
} ;


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

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

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

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

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


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

/*! Fonction qui renvoit le pointeur sur le paramètre Y du spectre.
 */
inline const Param * SpecBidim::GetYParamPtr ( ) const
  { return ( Spec2Par::GetYParamPtr() ); }

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


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

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

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

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

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


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

/*! Fonction qui renvoit le pointeur sur le paramètre Y du spectre.
 */
inline const Param * SpecBidim::GetYParamPtr ( ) const
  { return ( Spec2Par::GetYParamPtr() ); }

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

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