| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4LogicalSurface
27 //
28 // Class description:
29 //
30 // An abstraction of a geometrical surface, it is an abstract
31 // base class for different implementations of surfaces.
32 // Its primary function is to hold pointers to objects that describe the
33 // surface's physical properties. For example it holds a pointer to a
34 // surface's optical properties, and because of this it is used in processes
35 // like G4OpBoundaryProcess.
36 //
37 // Methods:
38 // G4SurfaceProperty* GetSurfaceProperty() const
39 // void SetSurfaceProperty(G4SurfaceProperty*)
40 //
41 // G4String GetName() const
42 // void SetName(const G4String&)
43 //
44 // G4TransitionRadiationSurface* GetTransitionRadiationSurface() const
45 // void SetTransitionRadiationSurface(G4TransitionRadiationSurface*)
46 //
47 // Data members:
48 // G4String theName
49 // G4SurfaceProperty* theSurfaceProperty
50 // G4TransitionRadiationSurface* theTransRadSurface
51
52 // Created: 1997, June, 4th to 17th
53 // Author: John Apostolakis, (with help of Peter Gumplinger)
54 // ------------------------------------------------------------------------
55 #ifndef G4LOGICALSURFACE_HH
56 #define G4LOGICALSURFACE_HH 1
57
58 #include "G4Types.hh"
59 #include "G4String.hh"
60
61 class G4SurfaceProperty;
62 class G4TransitionRadiationSurface;
63
64 class G4LogicalSurface
65 {
66
67 public:
68
69 inline G4SurfaceProperty* GetSurfaceProperty() const;
70 inline void SetSurfaceProperty(G4SurfaceProperty* ptrSurfaceProperty);
71
72 inline const G4String& GetName() const;
73 inline void SetName(const G4String& name);
74
75 inline G4TransitionRadiationSurface* GetTransitionRadiationSurface() const;
76 inline void SetTransitionRadiationSurface(G4TransitionRadiationSurface* trs);
77
78 virtual ~G4LogicalSurface() = default;
79
80 G4LogicalSurface(const G4LogicalSurface&) = delete;
81 G4LogicalSurface& operator=(const G4LogicalSurface&) = delete;
82
83 inline G4bool operator==(const G4LogicalSurface &right) const;
84 inline G4bool operator!=(const G4LogicalSurface &right) const;
85
86 protected:
87
88 // There should be no instances of this class
89
90 G4LogicalSurface(const G4String& name, G4SurfaceProperty* prop);
91 // Is the name more meaningful for the properties or the logical surface ?
92
93 private:
94
95 G4String theName; // Surface name
96
97 G4SurfaceProperty* theSurfaceProperty = nullptr;
98 G4TransitionRadiationSurface* theTransRadSurface = nullptr;
99 };
100
101 #include "G4LogicalSurface.icc"
102
103 #endif
104