step_hit_processor_factory.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-06-04
 * Last modified: 2014-04-30
 *
 * License:
 *
 * Description:
 *
 *   Step hit processor factory
 *
 */

#ifndef MCTOOLS_STEP_HIT_PROCESSOR_FACTORY_H
#define MCTOOLS_STEP_HIT_PROCESSOR_FACTORY_H 1

// Standard library:
#include <sstream>
#include <string>
#include <map>
#include <stdexcept>
#include <set>

// Third party:
// - Bayeux/datatools:
#include <datatools/ioutils.h>
#include <datatools/properties.h>
#include <datatools/multi_properties.h>
#include <datatools/handle.h>
#include <datatools/i_tree_dump.h>

// This project:
#include <mctools/base_step_hit_processor.h>

namespace datatools {
  class properties;
  class service_manager;
}

namespace mygsl {
  class rng;
}

namespace mctools {

  class step_hit_processor_factory
    : public datatools::i_tree_dumpable
  {
  public:

    typedef datatools::handle<base_step_hit_processor> processor_handle_type;

    struct processor_entry_type {
      std::string name;
      std::string type;
      datatools::properties config;
      processor_handle_type handle;
      virtual ~processor_entry_type();
      void reset();
    };
    typedef std::map<std::string, processor_entry_type>      processor_entry_dict_type;
    typedef std::map<std::string, base_step_hit_processor *> processor_dict_type;

    static const std::string & default_detailed_hit_collection();

    static const std::string & matching_output_profiles_key();

    bool is_initialized () const;

    const std::string & get_description () const;

    void set_description (const std::string & description_);

    bool has_geometry_manager () const;

    void set_geometry_manager (const geomtools::manager & gmgr_);

    const geomtools::manager & get_geometry_manager () const;

    bool has_service_manager () const;

    void set_service_manager (datatools::service_manager & smgr_);

    datatools::service_manager & grab_service_manager ();

    const datatools::service_manager & get_service_manager () const;

    void set_instantiate_at_loading(bool);

    bool has_external_prng () const;

    void set_external_prng (mygsl::rng & prng_);

    mygsl::rng & grab_external_prng();

    void set_output_profiles(const std::set<std::string> & output_profiles_);

    void reset_output_profiles();

    void initialize();

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

    void reset ();

    step_hit_processor_factory (datatools::logger::priority logging_ = datatools::logger::PRIO_WARNING);

    virtual ~step_hit_processor_factory ();

    // /// Returns the mutable dictionary of instantiated processors
    // processor_dict_type & grab_processors ();

    const processor_dict_type & get_processors () const;

    void fetch_processor_names(std::vector<std::string> & vprocs_, bool only_instantiated_ = false) const;

    bool create(const std::string & name_,
                const std::string & type_,
                const datatools::properties & config_);

    bool has_processor (const std::string & name_) const;

    bool is_processor_instantiated(const std::string & name_) const;

    bool is_processor_instantiable(const std::string & name_) const;

    base_step_hit_processor & grab_processor (const std::string & name_);

    const base_step_hit_processor & get_processor (const std::string & name_) const;

    void dump (std::ostream & out_) const;

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

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

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

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

  protected:

    base_step_hit_processor * _create(const std::string & name_);

    void _initialize();

  private:

    base_step_hit_processor::factory_register_type _factory_register_; 

    bool                         _initialized_ = false;     
    datatools::logger::priority  _logging_priority_;
    std::string                  _description_;     
    datatools::service_manager * _service_manager_ = nullptr; 
    const geomtools::manager   * _geom_manager_ = nullptr;    
    mygsl::rng                 * _external_prng_ = nullptr;   
    std::set<std::string>        _output_profiles_; 
    bool                         _instantiate_at_loading_ = false; 
    processor_entry_dict_type    _entries_;         
    processor_dict_type          _processors_;      

  };


} // end of namespace mctools


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

#endif // MCTOOLS_STEP_HIT_PROCESSOR_FACTORY_H

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