Event.hh

Go to the documentation of this file.

//======================================================================
/*! \file Event.hh
 *
 *  Déclaration des méthodes de la classe Event qui décrit
 *  une structure d'événement.
 */
//======================================================================

#ifndef EVENT_HH
#define EVENT_HH

#include "GVectT.hh"
#include "Param.hh"

//======================================================================
/*! \class Event
 *
 *  Cette classe décrit la structure d'événement, comme un tableau
 *  de paramètres de type variable.
 */

class Event : public GVectT<Param>
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(Event);
//----------------------------------------------------------------------

  /// Codes d'information
  enum EventInfo
  {
    undefinedParam  = -1      // paramètre non défini
  };

  protected:


  public:

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

    // Constructeur par défaut.
    Event ( );

    // Constructeur de recopie.
    Event ( const Event & );

    // Operateur d'affectation.
    Event & operator = ( const Event & );

    // Destructeur
    virtual ~Event ( );

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

    // Ajout d'un paramètre
    Param * AddParam ( const Param & );

    // Remise à séro d'un événement
    void    Reset ( );

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

    // Ecriture de la structure des paramètres sur la sortie standard.
    void Print ( ) const;

    // Ecriture de la structure des paramètres dans un fichier.
    void Print ( const string &file_name ) const;

    // Ecriture de la structure des paramètres dans un flux de sortie.
    void Print ( ostream &os ) const;

    /// Ecriture de l'événement dans son état actuel (avec les valeurs des
    //  paramètres affectés) sur la sortie standard.
    void Dump ( const u_int pmin = 0,
                const u_int pmax = 0,
                const bool  all  = false ) const;

    // Ecriture de l'événement dans son état (avec les valeurs des
    // paramètres affectés) dans un fichier.
    void Dump ( const string &file_name, const u_int pmin = 0,
                                         const u_int pmax = 0,
                                         const bool  all  = false ) const;

    // Ecriture de l'événement dans son état (avec les valeurs des
    // paramètres affectés) dans un flux de sortie.
    void Dump ( ostream &os, const u_int pmin = 0,
                             const u_int pmax = 0,
                             const bool  all  = false ) const;

    // Renvoi l'index (numéro) ou le pointeur  d'un paramètre à partir
    // de son nom ou de son numéro
    int           GetParamIndex ( const string &par_name ) const;
    const Param * GetParamPtr   ( const string &par_name ) const;
    const Param * GetParamPtr   ( const u_int n ) const;
    const string  GetParamName  ( const u_int n ) const;

    int           GetParamDimension ( const u_int n ) const;
    int           GetParamDimension ( const string &par_name ) const;

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


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


/*! Ecriture de la structure des paramètres sur la sortie standard.
 */
inline void Event::Print ( ) const
  { Print (cout); }

/*! Ecriture de l'événement dans son état actuel (avec les valeurs des
 *  paramètres affectés) sur la sortie standard.
 *  \param  pmin  numéro du 1er paramètre à écrire
 *  \param  pmax  numéro du dernier paramètre à écrire
 *  \param  all   indique s'il faut aussi écrire les paramètres non affectés */
inline void Event::Dump ( const u_int pmin,
                          const u_int pmax,
                          const bool  all ) const
  { Dump (cout, pmin, pmax, all); }

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

 */
inline void Event::Dump ( const u_int pmin,
                          const u_int pmax,
                          const bool  all ) const
  { Dump (cout, pmin, pmax, all); }

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