SimulRun.hh

Go to the documentation of this file.

//======================================================================
/*! \file SimulRun.hh
 *
 *  Déclaration de la classe SimulRun, classe de base pour générer
 *  des simulation (analyses sans fichier d'entrée).
 */
//======================================================================


#ifndef SIMUL_RUN_HH
#define SIMUL_RUN_HH

#include "RunBase.hh"

//======================================================================
/*! \class SimulRun
 *
 *  C'est une classe de base pour générer des simulations (runs sans
 *  fichier d'entrée).
 *
 *  C'est une classe abstraite: elle doit être dérivée.
 *  La classe dérivée doit définir les fonctions suivantes :
 *  - \b CreateEvent :   création des paramètres bruts de la simulation
 *  - \b FillRawEvent :  affectation des paramètres bruts
 *  L'utilisation de ces fonctions est facultative : tous les paramètres
 *  peuvent être créés et remplis dans les fonctions utilisateur
 *  (UserEventDefine et UserEvent).
 *
 *  Les données "brutes" des événements sont simulées et ne nécessitent
 *  donc pas de fichier d'entrée.
 *  Néanmoins, on définit tout de même des pseudo-fichiers, avec un numéro
 *  et un nom, pour la création automatique des TTree en sortie:
 *  - numéro pour les TTrees avec un format numérique dans leur nom;
 *  - nom pour les TTrees avec dans leur nom le nom du fichier d'entrée;
 *
 *  Ceci n'a d'intérêt que pour identifier des résultats en sortie
 *  (TTree ou autre).
 *  Si ce n'est pas le cas, il n'y a pas lieu de s'en préoccuper,
 *  
 *
 *  Les pseudo-fichiers utilisent également un nombre maximum d'événements.
 *  Lorsque ce nombre a été généré, le numéro de fichier est incrémenté. *  Si ce nombre d'événements vaut 0, alors il n'y a pas de limite au
 *  pseudo-fichier.
 *
 *  Exemples:
 *
 *  - exécution d'une simulation de 1000 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 0 );

      run.Open ( );
      run.AnalyseEvents ( 1000 );
      run.Close ( );
 *  \endcode
 *
 *  - exécution d'une série de 3 simulations de 1000 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 1000 );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );
 *  \endcode
 *
 *  - exécution d'une série de simulations (runs 4, 5, 6, 8) de 500 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 500 );

      run.SetFileMode(RunBase::runList);
      run.SetFileNumbers ( "4:6,8" );
      run.Run();
 *  \endcode
 */
class SimulRun : virtual public RunBase
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObjectV(SimulRun);
//----------------------------------------------------------------------

  protected:
    bool    event_created;    ///< Test si l'arbre a été initialisé

    u_int   raw_param_num;    ///< Nombre de paramètres bruts de la simulation

    bool    file_open;        ///< Test processing of a series is started
    int     run_max_event;    ///< Nombre d'événement avant incrémentation du numéro de fichier

  public:
    // constructeur par défaut
    SimulRun ( );

    // destructeur
    virtual  ~SimulRun ( );

  protected:
    // constructeur de recopie
    SimulRun ( const SimulRun &original );

  public:
    // fonctions abstraites de la classe de base
    virtual int   Open    ( );
    virtual int   Open    ( const string &f_name );
    virtual int   Open    ( const u_int f_num );
    virtual bool  IsOpen  ( );
    virtual int   Close   ( );

    virtual int   RunInit   ( );
    virtual int   ReadEvent ( );

    virtual void  SetMaxRunEvents ( const int n );
    virtual int   GetMaxRunEvents ( ) const;

    // Lecture d'un ensemble d'événements
    virtual int   AnalyseEvents ( const u_int n );

  protected:
    virtual int   FileOpen     ( );
    virtual void  FileClose    ( );

    // création de la structure d'événement
    virtual int   CreateEvent  ( );
    virtual void  FillRawEvent ( );

//----------------------------------------------------------------------
  public:

  // fonction court-circuitées de la classe de base du fait
  // de l'absence de fichier réel
    virtual void    SetFileMode       ( const Int_t mode );

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


//======================================================================
//  FONCTIONS INLINE
//======================================================================

/*! Définit le nombre d'événements par run de simulation.
 *  \param  n   nombre maxi d'événements
 */
inline void SimulRun::SetMaxRunEvents ( const int n )
  { run_max_event = (n > 0) ? n : 0; }

/*! Retourne le nombre d'événements par run de simulation.*/
inline int SimulRun::GetMaxRunEvents ( ) const
  { return ( run_max_event ); }


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

 *  Si ce nombre d'événements vaut 0, alors il n'y a pas de limite au
 *  pseudo-fichier.
 *
 *  Exemples:
 *
 *  - exécution d'une simulation de 1000 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 0 );

      run.Open ( );
      run.AnalyseEvents ( 1000 );
      run.Close ( );
 *  \endcode
 *
 *  - exécution d'une série de 3 simulations de 1000 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 1000 );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );

      run.Open ( 0 );           // numéro de pseudo-fichier incrémenté automatiquement
      run.AnalyseEvents ( 0 );
      run.Close ( );
 *  \endcode
 *
 *  - exécution d'une série de simulations (runs 4, 5, 6, 8) de 500 événements
 *  \code
      MyClass run;

      run.Init();
      run.SetMaxRunEvents ( 500 );

      run.SetFileMode(RunBase::runList);
      run.SetFileNumbers ( "4:6,8" );
      run.Run();
 *  \endcode
 */
class SimulRun : virtual public RunBase
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObjectV(SimulRun);
//----------------------------------------------------------------------

  protected:
    bool    event_created;    ///< Test si l'arbre a été initialiséce313e4905@

    u_int   raw_param_num;    ///< Nombre de paramètres bruts de la simulation

    bool    file_open;        ///< Test processing of a series is started
    int     run_max_event;    ///< Nombre d'événement avant incrémentation du numéro de fichier

  public:
    // constructeur par défaut
    SimulRun ( );

    // destructeur
    virtual  ~SimulRun ( );

  protected:
    // constructeur de recopie
    SimulRun ( const SimulRun &original );

  public:
    // fonctions abstraites de la classe de base
    virtual int   Open    ( );
    virtual int   Open    ( const string &f_name );
    virtual int   Open    ( const u_int f_num );
    virtual bool  IsOpen  ( );
    virtual int   Close   ( );

    virtual int   RunInit   ( );
    virtual int   ReadEvent ( );

    virtual void  SetMaxRunEvents ( const int n );
    virtual int   GetMaxRunEvents ( ) const;

    // Lecture d'un ensemble d'événements
    virtual int   AnalyseEvents ( const u_int n );

  protected:
    virtual int   FileOpen     ( );
    virtual void  FileClose    ( );

    // création de la structure d'événement
    virtual int   CreateEvent  ( );
    virtual void  FillRawEvent ( );

//----------------------------------------------------------------------
  public:

  // fonction court-circuitées de la classe de base du fait
  // de l'absence de fichier réel
    virtual void    SetFileMode       ( const Int_t mode );

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


//======================================================================
//  FONCTIONS INLINE
//======================================================================

/*! Définit le nombre d'événements par run de simulation.
 *  \param  n   nombre maxi d'événements
 */
inline void SimulRun::SetMaxRunEvents ( const int n )
  { run_max_event = (n > 0) ? n : 0; }

/*! Retourne le nombre d'événements par run de simulation.*/
inline int SimulRun::GetMaxRunEvents ( ) const
  { return ( run_max_event ); }


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