| 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 // G4VIsotopeTable
27 //
28 // Class description:
29 //
30 // Virtual class for access to an isotope table containing
31 // "stable" isotopes with their properties.
32
33 // Author: H.Kurashige, 5 October 1999
34 // --------------------------------------------------------------------
35 #ifndef G4VIsotopeTable_hh
36 #define G4VIsotopeTable_hh 1
37
38 #include "G4Ions.hh"
39 #include "G4ios.hh"
40 #include "globals.hh"
41
42 class G4IsotopeProperty;
43
44 class G4VIsotopeTable
45 {
46 public:
47 // Constructors
48 G4VIsotopeTable() = default;
49 explicit G4VIsotopeTable(const G4String&);
50
51 // Copy contructor and assignment operator
52 G4VIsotopeTable(const G4VIsotopeTable&) = default;
53 G4VIsotopeTable& operator=(const G4VIsotopeTable&);
54
55 // Destructor
56 virtual ~G4VIsotopeTable() = default;
57
58 // Pure virtual method
59 virtual G4IsotopeProperty*
60 GetIsotope(G4int Z, G4int A, G4double E,
61 G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) = 0;
62
63 // Search the isotope in the table.
64 // The isotope is designated by
65 // G4int Z: number of proton (Atomic number)
66 // G4int A: number of nucleon (Atomic mass)
67 // and
68 // G4double E: excited energy
69 // G4Ions::G4FloatLevelBase flb: floating level base (from G4Ions.hh)
70 // or
71 // G4int level: isomer level
72 // in the given G4IsotopeProperty.
73 // If corresponding isotope exist in the table, this method returns
74 // 'true', as well as fills other properties such as spin, lifetime,
75 // decay modes and precise excited energy in the given G4IsotopeProperty.
76 // This method returns 'false' if no corresponding isotope is found
77 // without modification of property
78 virtual G4IsotopeProperty* GetIsotopeByIsoLvl(G4int Z, G4int A, G4int level = 0);
79
80 // Set/Get verbose level
81 G4int GetVerboseLevel() const;
82 void SetVerboseLevel(G4int level);
83
84 // Dump table
85 void DumpTable(G4int Zmin = 1, G4int Zmax = 118);
86
87 const G4String& GetName() const;
88
89 private:
90 G4String fName = "";
91 G4int verboseLevel = 0;
92 };
93
94 // ------------------------
95 // Inline methods
96 // ------------------------
97
98 inline const G4String& G4VIsotopeTable::GetName() const
99 {
100 return fName;
101 }
102
103 inline G4int G4VIsotopeTable::GetVerboseLevel() const
104 {
105 return verboseLevel;
106 }
107
108 inline void G4VIsotopeTable::SetVerboseLevel(G4int level)
109 {
110 verboseLevel = level;
111 }
112
113 #endif
114