nuclear_decay.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_NUCLEAR_DECAY_H
#define GENBB_HELP_NUCLEAR_DECAY_H 1

// Standard library:
#include <string>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/handle.h>
#include <datatools/logger.h>
#include <datatools/i_tree_dump.h>

namespace genbb {

  // Forward declaration
  class nuclear_level;
  class base_decay_driver;

  class nuclear_decay : public datatools::i_tree_dumpable
  {
  public:

    typedef datatools::handle<nuclear_decay> handle_type;

    nuclear_decay();

    virtual ~nuclear_decay();

    bool is_valid() const;

    bool check_decay(std::string &) const;

    bool has_decay_id() const;

    const std::string & get_decay_id() const;

    void set_decay_id(const std::string &);

    void set_level_initial(const nuclear_level &);

    const nuclear_level & get_level_initial() const;

    void set_level_final(const nuclear_level &);

    const nuclear_level & get_level_final() const;

    const datatools::properties & get_auxiliaries() const;

    datatools::properties & grab_auxiliaries();

    bool is_initialized() const;

    void initialize(const datatools::properties & config_,
                    const std::map<std::string, datatools::handle<nuclear_level> > * levels_ = 0);

    void initialize_simple();

    void reset();

    std::string to_string(unsigned int = 0) const;

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

    bool has_decay_driver() const;

    base_decay_driver & grab_decay_driver();

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

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

  protected:

    void _init_decay_driver(const datatools::properties &);

    void _set_default();

  private:

    bool _initialized_; 
    datatools::logger::priority _logging_; 
    std::string           _decay_id_;      
    const nuclear_level * _level_initial_; 
    const nuclear_level * _level_final_;   
    datatools::properties _auxiliaries_;   

    boost::scoped_ptr<base_decay_driver> _decay_driver_; 

  };

} // end of namespace genbb

#endif // GENBB_HELP_NUCLEAR_DECAY_H

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