time_slicer_generator.h

Go to the documentation of this file.

/* Author(s) :  Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2018-04-09
 * Last modified: 2018-04-09
 *
 * License:
 * Copyright 2018 F. Mauger
 *
 * 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 that use another generator and
 *   clusterize primary particles in special time slices.
 *
 * History:
 *
 */

#ifndef GENBB_HELP_TIME_SLICER_GENERATOR_H
#define GENBB_HELP_TIME_SLICER_GENERATOR_H 1

// Standard library:
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/units.h>

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

namespace genbb {

  class time_slicer_generator
    : public i_genbb
  {
  public:

    enum slice_mode_type {
      SM_UNDEF              = 0, 
      SM_PROMPT_EVENT_ONLY  = 1, 
      SM_DELAYED_EVENT_ONLY = 2, 
      SM_BOTH_EVENTS        = 3  
    };

    bool has_mode() const;

    void set_mode(const slice_mode_type);

    slice_mode_type get_mode() const;

    bool has_generator() const;

    void set_generator(i_genbb &);

    i_genbb & grab_generator();

    const i_genbb & get_generator() const;

    bool has_time_threshold() const;

    double get_time_threshold() const;

    void set_time_threshold(const double t_);

    bool has_time_cut() const;

    double get_time_cut() const;

    void set_time_cut(const double t_);

    void set_record_original_event_id(bool flag_);

    bool is_record_original_event_id() const;

    virtual bool can_external_random() const;

    time_slicer_generator();

    virtual ~time_slicer_generator();

    virtual bool is_initialized() const;

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

    virtual void reset();

    virtual bool has_next();

  protected:

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

  private:

    void _at_init_();

    void _at_reset_();

  private:

    // Management:
    bool _initialized_ = false; 

    // Configuration:
    i_genbb * _pg_ = nullptr; 
    double _time_threshold_;  
    double _time_cut_;        
    slice_mode_type _mode_ = SM_UNDEF; 
    bool _record_original_event_id_ = true; 

    // Working data:
    primary_event _buffer_event_;
    std::size_t   _original_event_counter_ = 0;

    GENBB_PG_REGISTRATION_INTERFACE(time_slicer_generator)

  };

} // end of namespace genbb

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

#endif // GENBB_HELP_TIME_SLICER_GENERATOR_H

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