electromagnetic_field_manager.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2012-04-24
 * Last modified: 2013-06-19
 *
 * License:
 *
 * Description:
 *
 *   Manager for a collection of electro-magnetic fields
 *
 * History:
 *
 */

#ifndef EMFIELD_ELECTROMAGNETIC_FIELD_MANAGER_H
#define EMFIELD_ELECTROMAGNETIC_FIELD_MANAGER_H 1

// Standard library:
#include <iostream>
#include <string>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/i_tree_dump.h>
#include <datatools/multi_properties.h>
#include <datatools/bit_mask.h>

// This project:
#include <emfield/base_electromagnetic_field.h>

namespace datatools {
  class service_manager;
}

namespace geomtools {
  class manager;
}

namespace emfield {

  class geom_map;

  class electromagnetic_field_manager : public datatools::i_tree_dumpable
  {

  public:

    enum init_flags {
      INIT_DEBUG      = datatools::bit_mask::bit00,
      INIT_NO_PRELOAD = datatools::bit_mask::bit01
    };

    typedef base_electromagnetic_field::factory_register_type emfield_factory_type;

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

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

    bool is_initialized() const;

    void set_factory_preload(bool);

    void set_factory_verbose(bool);

    bool has_service_manager() const;

    void set_service_manager(datatools::service_manager &);

    void reset_service_manager();

    bool has_geometry_manager() const;

    void set_geometry_manager(const geomtools::manager &);

    const geomtools::manager & get_geometry_manager() const;

    bool has_geom_map() const;

    electromagnetic_field_manager(uint32_t flags_ = 0);

    virtual ~electromagnetic_field_manager();

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

    void reset();

    void load(const std::string & field_definitions_filename_);

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

    const base_electromagnetic_field::field_dict_type & get_fields() const;

    bool has_field(const std::string & field_name_) const;

    base_electromagnetic_field & grab_field(const std::string & field_name_);

    const base_electromagnetic_field & get_field(const std::string & field_name_) const;

    const geom_map & get_geom_map() const;

  protected:

    void _set_defaults();

    void _set_initialized(bool initialized_);

  private:

    void _construct_();

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

  private:

    // Management:
    bool _initialized_;                                   

    // Parameters:
    datatools::logger::priority _logging_priority_;       
    bool                        _factory_verbose_;        
    bool                        _factory_preload_;        
    bool                        _build_geom_map_;         
    datatools::multi_properties _field_definitions_;      

    // Working data:
    boost::scoped_ptr<emfield_factory_type> _factory_register_; 
    datatools::service_manager * _service_manager_;       
    const geomtools::manager *   _geom_manager_;          
    base_electromagnetic_field::field_dict_type _fields_; 
    boost::scoped_ptr<geom_map> _geom_map_;               

  };

} // end of namespace emfield

#include <emfield/electromagnetic_field_macros.h>

#endif // EMFIELD_ELECTROMAGNETIC_FIELD_MANAGER_H 1

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