Bayeux  3.4.1
Core Foundation library for SuperNEMO
face_intercept_info.h
Go to the documentation of this file.
1 /* Author(s): François Mauger <mauger@lpccaen.in2p3.fr>
3  * Creation date: 2015-03-16
4  * Last modified: 2015-03-16
5  *
6  * License:
7  *
8  * Description:
9  *
10  * The identifier of a face in a shape
11  *
12  * History:
13  *
14  */
15 
16 // Standard library:
17 #include <iostream>
18 #include <string>
19 
20 // This project:
22 #include <geomtools/utils.h>
23 
24 #ifndef GEOMTOOLS_FACE_INTERCEPT_INFO_H
25 #define GEOMTOOLS_FACE_INTERCEPT_INFO_H 1
26 
27 namespace geomtools {
28 
30  // the intercept of a curve on the surface of a shape.
32  {
33  public:
34 
37 
39  void reset();
40 
42  const face_identifier & get_face_id() const;
43 
46 
48  void set_face_id(const face_identifier & fid_);
49 
51  void set_impact(const vector_3d & point_);
52 
54  const vector_3d & get_impact() const;
55 
58 
60  bool is_valid() const;
61 
63  bool is_ok() const;
64 
66  void print(std::ostream & out_, const std::string & indent_ = "") const;
67 
68  private:
69 
70  face_identifier _face_id_;
71  vector_3d _impact_;
72 
73  };
74 
75 } // end of namespace geomtools
76 
77 #endif // GEOMTOOLS_FACE_INTERCEPT_INFO_H
78 
79 /*
80 ** Local Variables: --
81 ** mode: c++ --
82 ** c-file-style: "gnu" --
83 ** tab-width: 2 --
84 ** End: --
85 */
face_identifier & grab_face_id()
Return the face identifier (mutable)
void print(std::ostream &out_, const std::string &indent_="") const
Print.
const face_identifier & get_face_id() const
Return the face identifier.
Identifier of a face attached to a solid shape.
Definition: face_identifier.h:32
The face_intercept_info class hosts the parameters of.
Definition: face_intercept_info.h:31
face_intercept_info()
Default constructor.
bool is_valid() const
Check validity of the intercept.
void set_impact(const vector_3d &point_)
Set the intercept/impact point.
bool is_ok() const
Intercept point exists.
const vector_3d & get_impact() const
Return the impact point.
CLHEP::Hep3Vector vector_3d
Alias for the CLHEP 3D-vector class.
Definition: clhep.h:63
vector_3d & grab_impact()
Return the impact point (mutable)
void set_face_id(const face_identifier &fid_)
Set the face identifier.
Top-level namespace of the Bayeux/geomtools module library.
Definition: electromagnetic_field_manager.h:39