i_vertex_generator.h

Go to the documentation of this file.

/* Author(s) : Francois Mauger <mauger@lpccaen.in2p3.fr>
 *             Xavier Garrido <garrido@lal.in2p3.fr>
 * Creation date: 2010-02-12
 * Last modified: 2014-07-15
 *
 * License:
 *
 * Description:
 *
 * History:
 *
 */

#ifndef GENVTX_I_VERTEX_GENERATOR_H
#define GENVTX_I_VERTEX_GENERATOR_H 1

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

// Third party:
// - Boost
#include <boost/scoped_ptr.hpp>
#include <boost/noncopyable.hpp>
// - Bayeux/datatools
#include <datatools/factory_macros.h>
#include <datatools/handle.h>
#include <datatools/i_tree_dump.h>
#include <datatools/logger.h>
#include <datatools/object_configuration_description.h>
// - Bayeux/geomtools
#include <geomtools/utils.h>
#include <geomtools/detail/model_tools.h>

// This project:
#include <genvtx/detail/vg_tools.h>
#include <genvtx/utils.h>

namespace datatools {
  class properties;
  class service_manager;
}

namespace geomtools {
  class manager;
}

namespace mygsl {
  class rng;
}

namespace genvtx {

  // Forward declaration:
  class vertex_validation;

  class i_vertex_generator : private boost::noncopyable,
                             public datatools::i_tree_dumpable
  {
  public:

    bool is_debug() const;

    void set_debug(bool debug_);

    bool has_name() const;

    const std::string & get_name() const;

    void set_name(const std::string &);

    bool has_geo_label() const;

    void set_geo_label(const std::string & geo_label_);

    const std::string & get_geo_label() const;

    bool has_geom_setup_requirement() const;

    void set_geom_setup_requirement(const std::string & geom_setup_requirement_);

    std::string get_geom_setup_requirement() const;

    void check_geom_setup_requirement(const geomtools::manager * gmgr_) const;

    bool has_external_prng() const;

    void set_vertex_validation_support(bool);

    virtual bool is_vertex_validation_supported() const;

    bool has_vertex_validation() const;

    void set_external_prng(mygsl::rng & prng_);

    bool has_prng() const;

    mygsl::rng & grab_prng();

    bool has_geom_manager() const;

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

    const geomtools::manager & get_geom_manager() const;

    bool has_total_weight() const;

    const weight_info & get_total_weight() const;

    bool is_time_generator() const;

    virtual bool has_next_vertex() const;

    void shoot_vertex(mygsl::rng & random_, geomtools::vector_3d & vertex_);

    void shoot_vertex(geomtools::vector_3d & vertex_);

    geomtools::vector_3d shoot_vertex(mygsl::rng & random_);

    void shoot_vertex_and_time(mygsl::rng & random_, geomtools::vector_3d & vertex_, double & time_);

    void shoot_vertex_and_time(geomtools::vector_3d & vertex_, double & time_);

    virtual void initialize_simple();

    virtual void initialize_standalone(const datatools::properties & setup_);

    virtual void initialize_with_service_only(const datatools::properties & setup_,
                                              datatools::service_manager & service_manager_);

    virtual void initialize_with_dictionary_only(const datatools::properties & setup_,
                                                 vg_dict_type & dictionary_);

    i_vertex_generator();

    virtual ~i_vertex_generator();

    virtual bool is_initialized() const = 0;

    virtual void initialize(const datatools::properties & setup_,
                            datatools::service_manager & service_manager_,
                            vg_dict_type & dictionary_) = 0;

    virtual void reset() = 0;

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

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

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

    static void ocd_support(datatools::object_configuration_description &, const std::string & label_ = "");

  protected:

    void _set_time_generator(bool);

    void _initialize(const datatools::properties & setup_,
                     datatools::service_manager & service_manager_);

    void _reset();

    weight_info & _grab_total_weight();

    void _set_total_weight(const weight_info & a_info);

    void _initialize_basics(const datatools::properties & setup_,
                            datatools::service_manager & service_manager_);

    void _initialize_geo_manager(const datatools::properties & setup_,
                                 datatools::service_manager & service_manager_);

    void _initialize_vertex_validation(const datatools::properties & setup_,
                                       datatools::service_manager & service_manager_);

    vertex_validation & _grab_vertex_validation();

    virtual void _shoot_vertex(mygsl::rng & random_,
                               geomtools::vector_3d & vertex_);

    virtual void _shoot_vertex_and_time(mygsl::rng & random_,
                                        geomtools::vector_3d & vertex_,
                                        double & time_);

  private:

    void _shoot_vertex_(mygsl::rng & random_, geomtools::vector_3d & vertex_);

    void _shoot_vertex_and_time_(mygsl::rng & random_, geomtools::vector_3d & vertex_, double & time_);

  protected:

    datatools::logger::priority  _logging_priority; 

  private:

    std::string                  _name_;         
    bool                         _time_generator_; 
    std::string                  _geo_label_;    
    std::string                  _geom_setup_requirement_; 
    const ::geomtools::manager * _geom_manager_; 
    weight_info                  _total_weight_; 
    mygsl::rng                 * _external_prng_; 
    bool                         _vertex_validation_support_; 
    boost::scoped_ptr<vertex_validation> _vertex_validation_; 

    // Factory declaration :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(i_vertex_generator)

  };

} // end of namespace genvtx

#include <genvtx/vg_macros.h>

#endif // GENVTX_I_VERTEX_GENERATOR_H

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