base_decay_driver.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-06-08
 * Last modified: 2014-06-08
 *
 * License:
 * Copyright 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:
 *
 *   Description of a nuclear decay.
 *
 * History:
 *
 */

#ifndef GENBB_HELP_BASE_DECAY_DRIVER_H
#define GENBB_HELP_BASE_DECAY_DRIVER_H 1

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

namespace datatools {
  // Forward declaration:
  class properties;
}

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

namespace genbb {

  // Forward declaration:
  class primary_event;
  class nuclear_level;
  class nuclear_decay;

  class base_decay_driver : public datatools::i_tree_dumpable
  {
  public:

    base_decay_driver();

    virtual ~base_decay_driver();

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

    void set_logging(datatools::logger::priority);

    virtual void tree_dump(std::ostream & out_ = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

    bool is_initialized() const;

    void initialize_simple();

    virtual void set_levels(const nuclear_level & level_initial_,
                            const nuclear_level & level_final_);

    virtual void initialize(const datatools::properties & setup_) = 0;

    virtual void reset() = 0;

    virtual int fill(mygsl::rng & prng_, primary_event & event_) = 0;

  protected:

    void _set_default();

    void _set_initialized(bool);

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

  private:

    datatools::logger::priority _logging_;     
    bool                        _initialized_; 
    const nuclear_decay *       _decay_;       

    // Factory stuff :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(base_decay_driver)

  };


  class decay_driver_factory : public datatools::i_tree_dumpable
  {
  public:

    static base_decay_driver * create(const std::string & driver_id_);

  };

} // end of namespace genbb

#endif // GENBB_HELP_BASE_DECAY_DRIVER_H

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