Geant4  10.00.p03
G4LogicalSurface.hh
Go to the documentation of this file.
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 //
27 // $Id: G4LogicalSurface.hh 81594 2014-06-03 14:05:18Z gcosmo $
28 //
30 // Class G4LogicalSurface
32 //
33 // Class description:
34 //
35 // An abstraction of a geometrical surface, it is an abstract
36 // base class for different implementations of surfaces.
37 // Its primary function is to hold pointers to objects that describe the
38 // surface's physical properties. For example it holds a pointer to a
39 // surface's optical properties, and because of this it is used in processes
40 // like G4OpBoundaryProcess.
41 //
42 // Methods:
43 // G4SurfaceProperty* GetSurfaceProperty() const
44 // void SetSurfaceProperty(G4SurfaceProperty*)
45 //
46 // G4String GetName() const
47 // void SetName(const G4String&)
48 //
49 // G4TransitionRadiationSurface* GetTransitionRadiationSurface() const
50 // void SetTransitionRadiationSurface(G4TransitionRadiationSurface*)
51 //
52 // Data members:
53 // G4String theName
54 // G4SurfaceProperty* theSurfaceProperty
55 // G4TransitionRadiationSurface* theTransRadSurface
56 
57 // Created: 1997, June, 4th to 17th
58 // Author: John Apostolakis, (with help of Peter Gumplinger)
59 // mail: japost@mail.cern.ch
60 //
61 // ------------------------------------------------------------------------
62 #ifndef G4LogicalSurface_h
63 #define G4LogicalSurface_h 1
64 
66 // Includes
68 
69 #include "G4Types.hh"
70 #include "G4String.hh"
71 
72 class G4SurfaceProperty;
73 class G4TransitionRadiationSurface;
74 
76 // Class Definition
78 
80 {
81 
82  public: // with description
83 
84  inline G4SurfaceProperty* GetSurfaceProperty() const;
85  inline void SetSurfaceProperty(G4SurfaceProperty* ptrSurfaceProperty);
86 
87  inline const G4String& GetName() const;
88  inline void SetName(const G4String& name);
89 
90  inline G4TransitionRadiationSurface* GetTransitionRadiationSurface() const;
91  inline void SetTransitionRadiationSurface(G4TransitionRadiationSurface* tRadSurf);
92 
93  public: // without description
94 
95  virtual ~G4LogicalSurface();
96 
97  inline G4int operator==(const G4LogicalSurface &right) const;
98  inline G4int operator!=(const G4LogicalSurface &right) const;
99 
100  protected:
101 
102  // There should be no instances of this class
103 
104  G4LogicalSurface(const G4String& name, G4SurfaceProperty* prop);
105  // Is the name more meaningful for the properties or the logical surface ?
106 
107  private: // Copying restricted
108 
109  G4LogicalSurface(const G4LogicalSurface &right);
110  inline G4LogicalSurface& operator=(const G4LogicalSurface& right);
111 
112  private:
113 
114  G4String theName; // Surface name
115 
117  G4TransitionRadiationSurface* theTransRadSurface;
118 };
119 
121 // Inline methods
123 
124 #include "G4LogicalSurface.icc"
125 
126 #endif /* G4LogicalSurface_h */
G4TransitionRadiationSurface * GetTransitionRadiationSurface() const
G4TransitionRadiationSurface * theTransRadSurface
G4SurfaceProperty * theSurfaceProperty
G4String name
Definition: TRTMaterials.hh:40
G4int operator!=(const G4LogicalSurface &right) const
void SetName(const G4String &name)
int G4int
Definition: G4Types.hh:78
G4LogicalSurface(const G4String &name, G4SurfaceProperty *prop)
const G4String & GetName() const
void SetTransitionRadiationSurface(G4TransitionRadiationSurface *tRadSurf)
G4int operator==(const G4LogicalSurface &right) const
G4LogicalSurface & operator=(const G4LogicalSurface &right)
void SetSurfaceProperty(G4SurfaceProperty *ptrSurfaceProperty)
G4SurfaceProperty * GetSurfaceProperty() const
virtual ~G4LogicalSurface()