manager.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-09-22
 * Last modified: 2016-02-11
 *
 * License:
 *
 * Description:
 *
 *   A manager for isotopes, elements and materials (and material aliases)
 *
 * History:
 *
 */

#ifndef MATERIALS_MANAGER_H
#define MATERIALS_MANAGER_H 1

// Standard library:
#include <ostream>
#include <string>
#include <list>
#include <set>

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

// This project:
//#include <materials/factory.h>
#include <materials/isotope.h>
#include <materials/element.h>
#include <materials/material.h>
#include <materials/detail/tools.h>

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

namespace materials {

  // Forward declaration:
  class factory;

  class manager : public datatools::i_tree_dumpable
  {
  public:

    static bool validate_name_for_gdml(const std::string & candidate_);

    manager();

    virtual ~manager();

    bool is_initialized() const;

    bool is_debug() const;

    void set_debug(bool);

    bool is_locked() const;

    bool is_alias_of_alias_allowed() const;

    void set_alias_of_alias_allowed(bool aoaa_);

    bool is_alias_allow_overload() const;

    void set_alias_allow_overload(bool aao_);

    bool has_isotope(const std::string & entry_name_) const;

    const isotope & get_isotope(const std::string & entry_name_) const;

    bool has_element(const std::string & entry_name_) const;

    const element & get_element(const std::string & entry_name_) const;

    bool has_material(const std::string & entry_name_) const;

    const material & get_material(const std::string & entry_name_) const;

    bool is_alias(const std::string & entry_name_) const;

    std::string alias_of(const std::string & entry_name_) const;

    const isotope_dict_type & get_isotopes() const;

    const element_dict_type & get_elements() const;

    const material_dict_type & get_materials() const;

    const std::list<std::string> & get_ordered_materials() const;

    void load(const datatools::multi_properties & config_);

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

    void reset();

    void lock();

    void unlock();

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

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

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

    bool is_load_isotope_mass_data() const;

    void set_load_isotope_mass_data(bool);

    bool is_load_isotope_decay_data() const;

    void set_load_isotope_decay_data(bool);


    void add_material_exported_prefix(const std::string &);

    const std::set<std::string> & get_material_exported_prefixes() const;

  protected:

    void _set_defaults();

  private:

    // Management:
    bool                        _locked_;           
    datatools::logger::priority _logging_priority_; 
    // Configuration attributes:
    bool                   _load_isotope_mass_data_;     
    bool                   _load_isotope_decay_data_;    
    std::set<std::string>  _material_exported_prefixes_; 
    bool                   _alias_allow_overload_;       
    bool                   _alias_of_alias_allowed_;     
    // Dynamic attributes:
    boost::scoped_ptr<factory> _creator_; 
    isotope_dict_type      _isotopes_; 
    element_dict_type      _elements_; 
    material_dict_type     _materials_; 
    std::list<std::string> _ordered_materials_; 

  };

} // end of namespace materials

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

#endif // MATERIALS_MANAGER_H

/*
** Local Variables: --
** mode: c++ --
** c-file-style: "gnu" --
** tab-width: 2 --
** End: --
*/