| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 << 25 //
>> 26 //
>> 27 // $Id: G4SurfaceProperty.hh 70822 2013-06-06 08:25:05Z gcosmo $
>> 28 //
>> 29 //
26 ////////////////////////////////////////////// 30 ////////////////////////////////////////////////////////////////////////
27 // G4SurfaceProperty Definition 31 // G4SurfaceProperty Definition
28 ////////////////////////////////////////////// 32 ////////////////////////////////////////////////////////////////////////
29 // 33 //
30 // Class Description: 34 // Class Description:
31 // 35 //
32 // A base class describing a surface property. 36 // A base class describing a surface property.
33 // Derived classes are G4Opticalsurface, G4Fir << 37 // Derived classes are G4Opticalsurface, G4Firovsurface, etc.
34 // Contains the enumeration G4SurfaceType. 38 // Contains the enumeration G4SurfaceType.
35 39
36 // File: G4SurfaceProperty.hh 40 // File: G4SurfaceProperty.hh
37 // Description: A base class for for descripin 41 // Description: A base class for for descriping surface property such
38 // as G4OpticalSurface, G4FirsovS 42 // as G4OpticalSurface, G4FirsovSurface, G4X-raySurface
39 // Version: 1.0 43 // Version: 1.0
40 // Created: 13-10-2003 44 // Created: 13-10-2003
41 // Author: Fan Lei 45 // Author: Fan Lei
42 // Updated: Mariele Stockhoff 2017-02-24 a << 46 //
43 ////////////////////////////////////////////// 47 ////////////////////////////////////////////////////////////////////////
44 48
45 #ifndef G4SurfaceProperty_h 49 #ifndef G4SurfaceProperty_h
46 #define G4SurfaceProperty_h 1 50 #define G4SurfaceProperty_h 1
47 51
48 #include "G4String.hh" << 52 /////////////
49 #include "G4Types.hh" << 53 // Includes
>> 54 /////////////
50 55
51 #include <vector> 56 #include <vector>
52 57
>> 58 #include "G4Types.hh"
>> 59 #include "G4String.hh"
>> 60
53 class G4SurfaceProperty; 61 class G4SurfaceProperty;
54 62
55 using G4SurfacePropertyTable = std::vector<G4S << 63 typedef std::vector<G4SurfaceProperty*> G4SurfacePropertyTable;
56 64
57 // clang-format off <<
58 enum G4SurfaceType 65 enum G4SurfaceType
59 { 66 {
60 dielectric_metal, // dielectric-metal << 67 dielectric_metal, // dielectric-metal interface
61 dielectric_dielectric, // dielectric-dielec << 68 dielectric_dielectric, // dielectric-dielectric interface
62 dielectric_LUT, // dielectric-Look-U << 69 dielectric_LUT, // dielectric-Look-Up-Table interface
63 dielectric_LUTDAVIS, // dielectric-Look-U << 70 dielectric_dichroic, // dichroic filter interface
64 dielectric_dichroic, // dichroic filter i << 71 firsov, // for Firsov Process
65 firsov, // for Firsov Proces << 72 x_ray // for x-ray mirror process
66 x_ray, // for x-ray mirror <<
67 coated // coated_dielectric- <<
68 }; 73 };
69 // clang-format on << 74
>> 75 /////////////////////
>> 76 // Class Definition
>> 77 /////////////////////
70 78
71 class G4SurfaceProperty 79 class G4SurfaceProperty
72 { 80 {
73 public: << 81 public: // Without description
74 // Constructor of a X-ray optical surface ob << 82
75 G4SurfaceProperty(); << 83 //////////////
76 G4SurfaceProperty(const G4String& name, G4Su << 84 // Operators
77 virtual ~G4SurfaceProperty() = default; << 85 //////////////
78 << 86
79 // Returns the surface name. << 87 // G4SurfaceProperty(const G4SurfaceProperty &right);
80 const G4String& GetName() const { return the << 88 // const G4SurfaceProperty & operator=(const G4SurfaceProperty &right);
81 // Sets the surface name. << 89
82 void SetName(const G4String& name) { theName << 90 // G4int operator==(const G4SurfaceProperty &right) const;
83 << 91 // G4int operator!=(const G4SurfaceProperty &right) const;
84 // Returns the surface type. << 92
85 const G4SurfaceType& GetType() const { retur << 93 public: // With description
86 // Sets the surface type. << 94
87 virtual void SetType(const G4SurfaceType& ty << 95 ////////////////////////////////
88 << 96 // Constructors and Destructor
89 // To handle the table of surface properties << 97 ////////////////////////////////
90 static void CleanSurfacePropertyTable(); << 98
91 static const G4SurfacePropertyTable* GetSurf << 99 G4SurfaceProperty(const G4String& name, G4SurfaceType type = x_ray);
92 static size_t GetNumberOfSurfaceProperties() << 100 // Constructor of a X-ray optical surface object.
93 static void DumpTableInfo(); << 101
>> 102 public: // Without description
>> 103
>> 104 G4SurfaceProperty();
>> 105 virtual ~G4SurfaceProperty();
>> 106
>> 107 ////////////
>> 108 // Methods
>> 109 ////////////
>> 110
>> 111 public: // With description
>> 112
>> 113 const G4String& GetName() const { return theName; }
>> 114 // Returns the surface name.
>> 115 void SetName(const G4String& name) { theName = name; }
>> 116 // Sets the surface name.
>> 117
>> 118 const G4SurfaceType& GetType() const { return theType; }
>> 119 // Returns the surface type.
>> 120 void SetType(const G4SurfaceType& type) { theType = type; }
>> 121 // Sets the surface type.
>> 122
>> 123 static void CleanSurfacePropertyTable();
>> 124 static const G4SurfacePropertyTable* GetSurfacePropertyTable();
>> 125 static size_t GetNumberOfSurfaceProperties();
>> 126 static void DumpTableInfo();
>> 127 // To handle the table of surface properties.
>> 128
>> 129 protected:
>> 130
>> 131 // ------------------
>> 132 // Basic data members ( To define surface property)
>> 133 // ------------------
94 134
95 protected: << 135 G4String theName; // Surface name
96 G4String theName; // Surface name <<
97 136
98 G4SurfaceType theType; // Surface type << 137 G4SurfaceType theType; // Surface type
99 138
100 static G4SurfacePropertyTable theSurfaceProp << 139 static G4SurfacePropertyTable theSurfacePropertyTable;
>> 140 // The static Table of SurfaceProperties.
101 }; 141 };
102 142
103 #endif /* G4SurfaceProperty_h */ 143 #endif /* G4SurfaceProperty_h */
104 144