i_genbb.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-09-28
 * Last modified: 2014-12-18
 *
 * License:
 * Copyright 2007-2014 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:
 *   GENBB generator abstract class
 *
 */

#ifndef GENBB_HELP_I_GENBB_H
#define GENBB_HELP_I_GENBB_H 1

// Third party:
// - Bayeux/datatools:
#include <datatools/factory_macros.h>
#include <datatools/logger.h>
#include <datatools/i_tree_dump.h>

// This project:
#include <genbb_help/detail/pg_tools.h>

namespace datatools {
  // Forward declarations:
  class properties;
  class service_manager;
  class object_configuration_description;
}

namespace mygsl {
  // Forward declaration:
  class rng;
}

namespace genbb {

  // Forward declaration:
  class primary_event;

  class i_genbb : public datatools::i_tree_dumpable
  {
  public:

    bool has_name() const;

    const std::string & get_name() const;

    void set_name(const std::string &);

    void reset_name();

    i_genbb();

    virtual ~i_genbb();

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

    virtual bool can_external_random() const;

    virtual bool has_external_random() const;

    virtual void set_external_random(mygsl::rng &);

    virtual void reset_external_random();

    mygsl::rng & grab_external_random();

    const mygsl::rng & get_external_random() const;

    virtual void initialize_simple();

    virtual void initialize_standalone(const datatools::properties & setup_);

    virtual void initialize_with_service_only(const datatools::properties & setup_,
                                              datatools::service_manager & service_manager_);

    virtual void initialize_with_dictionary_only(const datatools::properties & setup_,
                                                 detail::pg_dict_type & dictionary_);

    virtual bool is_initialized() const = 0;

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

    virtual void reset() = 0;

    virtual bool has_next() = 0;

    datatools::logger::priority get_logging_priority() const;

    void set_logging_priority(datatools::logger::priority p);

    bool is_debug() const;

    void set_assign_generation_ids(bool);

    bool is_assign_generation_ids() const;

    virtual void tree_dump(std::ostream& out = std::clog,
                           const std::string& title  = "",
                           const std::string& indent = "",
                           bool inherit = false) const;

    static void base_initialize_ocd(datatools::object_configuration_description &);

  protected:

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

    void _initialize_base(const datatools::properties & setup_);

  protected:

    datatools::logger::priority _logging_priority; 

  private:

    std::string  _name_; 
    mygsl::rng * _external_random_; 
    bool _assign_generation_ids_; 

    // Factory stuff :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(i_genbb)

  };

} // end of namespace genbb

#include <genbb_help/genbb_macros.h>

#endif // GENBB_HELP_I_GENBB_H

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