Bayeux  3.4.1
Core Foundation library for SuperNEMO
tube_model_vg.h
Go to the documentation of this file.
1 /* Author(s) : Francois Mauger <mauger@lpccaen.in2p3.fr>
3  * Creation date: 2013-06-14
4  * Last modified: 2014-04-09
5  *
6  * License:
7  *
8  * Description:
9  *
10  * Vertex generator from a tube model addressed through some
11  * collection of geometry IDs extracted from a mapping object.
12  *
13  * History:
14  *
15  */
16 
17 #ifndef GENVTX_TUBE_MODEL_VG_H
18 #define GENVTX_TUBE_MODEL_VG_H 1
19 
20 // Standard library:
21 #include <string>
22 
23 // Third party:
24 // // - Bayeux/geomtools:
25 // #include <geomtools/id_selector.h>
26 
27 // This project:
28 #include <genvtx/tube_vg.h>
29 #include <genvtx/vg_macros.h>
30 #include <genvtx/utils.h>
31 #include <genvtx/i_from_model_vg.h>
32 
33 namespace genvtx {
34 
37  {
38  public:
39 
40  bool is_mode_valid() const;
41 
42  bool is_mode_bulk() const;
43 
44  bool is_mode_surface() const;
45 
46  bool is_surface_inner_side() const;
47 
48  bool is_surface_outer_side() const;
49 
50  bool is_surface_bottom() const;
51 
52  bool is_surface_top() const;
53 
54  void set_surface_inner_side(bool);
55 
56  void set_surface_outer_side(bool);
57 
58  void set_surface_bottom(bool);
59 
60  void set_surface_top(bool);
61 
62  void set_skin_skip(double skin_skip_);
63 
64  void set_skin_thickness(double skin_thickness_);
65 
66  int get_mode() const;
67 
68  void set_mode(int);
69 
70  virtual void tree_dump(std::ostream & out_ = std::clog,
71  const std::string & title_ = "",
72  const std::string & indent_ = "",
73  bool inherit_ = false) const;
74 
76  tube_model_vg();
77 
79  virtual ~tube_model_vg();
80 
82  virtual void initialize(const ::datatools::properties &,
85 
87  virtual void reset();
88 
90  virtual bool is_initialized() const;
91 
92  protected :
93 
95  virtual void _shoot_vertex(::mygsl::rng & random_, ::geomtools::vector_3d & vertex_);
96 
97  void _shoot_vertex_tubes(mygsl::rng & random_,
98  geomtools::vector_3d & vertex_);
99 
100  private:
101 
102  void _init_();
103 
104  void _reset_();
105 
106  void _set_defaults_();
107 
108  private:
109 
110  bool _initialized_;
111  int _mode_;
112  bool _surface_inner_side_;
113  bool _surface_outer_side_;
114  bool _surface_bottom_;
115  bool _surface_top_;
116  genvtx::tube_vg _tube_vg_;
117  double _skin_skip_;
118  double _skin_thickness_;
119  std::vector<weight_entry_type> _entries_;
120 
124 
125  };
126 
127 } // end of namespace genvtx
128 
129 /***************
130  * OCD support *
131  ***************/
132 #include <datatools/ocd_macros.h>
134 
135 #endif // GENVTX_TUBE_MODEL_VG_H
136 
137 /*
138 ** Local Variables: --
139 ** mode: c++ --
140 ** c-file-style: "gnu" --
141 ** tab-width: 2 --
142 ** End: --
143 */
bool is_surface_bottom() const
void _shoot_vertex_tubes(mygsl::rng &random_, geomtools::vector_3d &vertex_)
Top-level namespace of the Bayeux/genvtx module library.
Definition: box_model_vg.h:32
virtual ~tube_model_vg()
Destructor.
void set_surface_bottom(bool)
bool is_surface_inner_side() const
bool is_mode_bulk() const
bool is_mode_valid() const
A vertex generator based on a tube geometry model.
Definition: tube_model_vg.h:36
virtual bool is_initialized() const
Check initialization status.
void set_skin_thickness(double skin_thickness_)
An abstract vertex generator based on a geometry model.
Definition: i_from_model_vg.h:39
void set_surface_inner_side(bool)
DOCD_CLASS_DECLARATION(my::algo)
Declaration of the OCD support for the my::algo class.
bool is_surface_outer_side() const
void set_surface_outer_side(bool)
tube_model_vg()
Constructor.
bool is_surface_top() const
void set_surface_top(bool)
CLHEP::Hep3Vector vector_3d
Alias for the CLHEP 3D-vector class.
Definition: clhep.h:63
void set_skin_skip(double skin_skip_)
virtual void _shoot_vertex(::mygsl::rng &random_, ::geomtools::vector_3d &vertex_)
Randomize vertex.
virtual void initialize(const ::datatools::properties &, ::datatools::service_manager &, ::genvtx::vg_dict_type &)
Initialization.
#define GENVTX_VG_REGISTRATION_INTERFACE(GENVTX_CLASS_NAME)
Definition: vg_macros.h:46
Macros to automatically register vertex generator class.
bool is_mode_surface() const
virtual void tree_dump(std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
Smart print.
std::map< std::string, vg_entry_type > vg_dict_type
Definition: vg_tools.h:125
A vertex generator based on the geometry of a 3D tube.
Definition: tube_vg.h:42
virtual void reset()
Reset.
Service management class.
Definition: service_manager.h:57
Pseudo random number generator.
Definition: rng.h:53