SpecTridim.hh

Go to the documentation of this file.

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

#ifndef SPEC_TRIDIM_HH
#define SPEC_TRIDIM_HH

#include "Spec3Dim.hh"
#include "Spec3Par.hh"

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

  protected:

  public:

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

    // Constructeur
    SpecTridim ( 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,
                const Param &par_z,
                const u_int nz, const double z1, const double z2 );

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

    // Destructeur
    virtual ~SpecTridim ();

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

  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;

    // Retourne une chaîne décrivant l'axe Z du spectre.
    string ZAxisDefinition ( ) 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 pointeur sur le paramètre Z du spectre.
    virtual const Param * GetZParamPtr ( ) 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(SpecTridim,0);
} ;


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

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

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

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

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

/*! Méthode qui retourne une chaîne décrivant l'axe Z du spectre
 */
inline string SpecTridim::ZAxisDefinition ( ) const
  { return ( AxisDefinition (ParamZ(), Zdim(), Zmin(), Zmax()) ); }


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

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

/*! Fonction qui renvoit le pointeur sur le paramètre Z du spectre.
 */
inline const Param * SpecTridim::GetZParamPtr ( ) const
  { return ( Spec3Par::GetZParamPtr() ); }

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


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

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

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

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

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

/*! Méthode qui retourne une chaîne décrivant l'axe Z du spectre
 */
inline string SpecTridim::ZAxisDefinition ( ) const
  { return ( AxisDefinition (ParamZ(), Zdim(), Zmin(), Zmax()) ); }


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

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

/*! Fonction qui renvoit le pointeur sur le paramètre Z du spectre.
 */
inline const Param * SpecTridim::GetZParamPtr ( ) const
  { return ( Spec3Par::GetZParamPtr() ); }

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

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