SpecUser2D.hh

Go to the documentation of this file.

//======================================================================
/*! \file SpecUser2D.hh
 *
 *  Déclaration de la classe SpecUser2D qui décrit les
 *  spectres utilisateurs 2D.
 */
//======================================================================

#ifndef SPEC_USER2D_HH
#define SPEC_USER2D_HH

#include "Spec2Dim.hh"

//======================================================================
/*! \class SpecUser2D
 *
 *  Classe des spectres utilistaeurs 2D.
 *  Le contenu de l'histogramme associé n'est ni incrémenté ni mis à jour
 *  automatiquement.
 *  Le spectre est laissé à la charge de l'utilisateur.
 */
class SpecUser2D : public Spec2Dim
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(SpecUser2D);
//----------------------------------------------------------------------

  protected:

  public:

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

    // Constructeur
    SpecUser2D ( const string & spec_name,
                 const u_int nx, const double x1, const double x2,
                 const u_int ny, const double y1, const double y2 );

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

    // Destructeur
    virtual ~SpecUser2D ();

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

  public:

    // mise à valeur et incrémentation manuelle du spectre
    virtual bool Increment ( const double x,  const double y,  const double incr = 1. );
    virtual bool Increment ( const int    ix, const int    iy, const double incr = 1. );
    virtual bool SetValue  ( const double x,  const double y,  const double val );
    virtual bool SetValue  ( const int    ix, const int    iy, const double val );

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

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

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


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

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


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

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

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


/*! Fonction qui retourne une chaîne décrivant l'axe X du spectre
 */
inline string SpecUser2D::XAxisDefinition ( ) const
  { return ( "X = (" + GGetString(Xdim(),dim_len) + ") ["
                     + GGetString(Xmin(),bound_len,bound_prec) + ";"
                     + GGetString(Xmax(),bound_len,bound_prec) + "]" ); }


/*! Fonction qui retourne une chaîne décrivant l'axe Y du spectre
 */
inline string SpecUser2D::YAxisDefinition ( ) const
  { return ( "Y = (" + GGetString(Ydim(),dim_len) + ") ["
                     + GGetString(Ymin(),bound_len,bound_prec) + ";"
                     + GGetString(Ymax(),bound_len,bound_prec) + "]" ); }

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