combined_particle_generator.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 *                Xavier Garrido <garrido@lal.in2p3.fr>
 * Creation date: 2010-10-03
 * Last modified: 2014-12-12
 *
 * License:
 * Copyright 2007-2014 F. Mauger, Xavier Garrido
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   A generator of GENBB-like event with a combined particle
 *
 * History:
 *
 */

#ifndef GENBB_HELP_COMBINED_PARTICLE_GENERATOR_H
#define GENBB_HELP_COMBINED_PARTICLE_GENERATOR_H 1

// Standard library:
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/units.h>
// - Bayeux/mygsl:
#include <mygsl/rng.h>
// - Bayeux/geomtools:
#include <geomtools/utils.h>

// This project:
#include <genbb_help/i_genbb.h>

namespace genbb {

  class combined_particle_generator
    : public i_genbb
  {
  public:

    enum time_delay_type {
      TIME_DELAY_UNDEFINED  = 0, 
      TIME_DELAY_FIXED      = 1, 
      TIME_DELAY_DECAY      = 2, 
      TIME_DELAY_RANGE      = 3, 
      TIME_DELAY_GAUSSIAN   = 4, 
      TIME_DELAY_DEFAULT    = TIME_DELAY_FIXED
    };

    struct entry_type
    {
      entry_type();
      bool is_valid() const;
      std::string label;    
      std::string name;     
      double    prob;       
      double    cumul_prob; 
      time_delay_type time_mode; 
      double    time;       
      double    time_width; 
      i_genbb * pg;         
    };

    typedef std::vector<entry_type> pg_col_type;

    enum mode_type {
      MODE_UNDEFINED         = 0, 
      MODE_PLAIN_PROBABILITY = 1, 
      MODE_ACTIVITY          = 2, 
      MODE_TIME              = 3  
    };

    void set_mode(int mode_);

    bool is_mode_time() const;

    bool is_mode_plain_probability() const;

    bool is_mode_activity() const;

    virtual bool can_external_random() const;

    const mygsl::rng & get_random() const;

    mygsl::rng & grab_random();

    combined_particle_generator();

    virtual ~combined_particle_generator();

    virtual void initialize(const datatools::properties & setup_,
                            datatools::service_manager & service_manager_,
                            detail::pg_dict_type & dictionary_);

    virtual void reset();

    virtual bool has_next();

    virtual bool is_initialized() const;

    void dump(std::ostream & out_, const std::string & title_, const std::string & indent_ = "") const;

  protected:

    virtual void _load_next(primary_event & event_,
                            bool compute_classification_ = true);

  private:

    void _at_init_();

    void _at_reset_();

  private:

    bool   _initialized_;            
    int    _mode_;                   
    unsigned long _seed_;            
    mygsl::rng    _random_;          
    pg_col_type   _generators_info_; 
    GENBB_PG_REGISTRATION_INTERFACE(combined_particle_generator)

  };

} // end of namespace genbb

/***************
 * OCD support *
 ***************/
#include <datatools/ocd_macros.h>
DOCD_CLASS_DECLARATION(genbb::combined_particle_generator)

#endif // GENBB_HELP_COMBINED_PARTICLE_GENERATOR_H

// Local Variables: --
// mode: c++ --
// End: --