include/Geant4/G4VIsotopeTable.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4VIsotopeTable
0027 //
0028 // Class description:
0029 //
0030 // Virtual class for access to an isotope table containing
0031 // "stable" isotopes with their properties.
0032
0033 // Author: H.Kurashige, 5 October 1999
0034 // --------------------------------------------------------------------
0035 #ifndef G4VIsotopeTable_hh
0036 #define G4VIsotopeTable_hh 1
0037
0038 #include "G4Ions.hh"
0039 #include "G4ios.hh"
0040 #include "globals.hh"
0041
0042 class G4IsotopeProperty;
0043
0044 class G4VIsotopeTable
0045 {
0046   public:
0047     // Constructors
0048     G4VIsotopeTable() = default;
0049     explicit G4VIsotopeTable(const G4String&);
0050
0051     // Copy contructor and assignment operator
0052     G4VIsotopeTable(const G4VIsotopeTable&) = default;
0053     G4VIsotopeTable& operator=(const G4VIsotopeTable&);
0054
0055     // Destructor
0056     virtual ~G4VIsotopeTable() = default;
0057
0058     // Pure virtual method
0059     virtual G4IsotopeProperty*
0060     GetIsotope(G4int Z, G4int A, G4double E,
0061                G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) = 0;
0062
0063     // Search the isotope in the table.
0064     // The isotope is designated by
0065     //    G4int    Z:  number of proton (Atomic number)
0066     //    G4int    A:  number of nucleon (Atomic mass)
0067     //      and
0068     //    G4double E:  excited energy
0069     //    G4Ions::G4FloatLevelBase flb: floating level base (from G4Ions.hh)
0070     //      or
0071     //    G4int  level: isomer level
0072     // in the given G4IsotopeProperty.
0073     // If corresponding isotope exist in the table, this method returns
0074     // 'true', as well as fills other properties such as spin, lifetime,
0075     // decay modes and precise excited energy in the given G4IsotopeProperty.
0076     // This method returns 'false' if no corresponding isotope is found
0077     // without modification of property
0078     virtual G4IsotopeProperty* GetIsotopeByIsoLvl(G4int Z, G4int A, G4int level = 0);
0079
0080     // Set/Get verbose level
0081     G4int GetVerboseLevel() const;
0082     void SetVerboseLevel(G4int level);
0083
0084     // Dump table
0085     void DumpTable(G4int Zmin = 1, G4int Zmax = 118);
0086
0087     const G4String& GetName() const;
0088
0089   private:
0090     G4String fName = "";
0091     G4int verboseLevel = 0;
0092 };
0093
0094 // ------------------------
0095 // Inline methods
0096 // ------------------------
0097
0098 inline const G4String& G4VIsotopeTable::GetName() const
0099 {
0100   return fName;
0101 }
0102
0103 inline G4int G4VIsotopeTable::GetVerboseLevel() const
0104 {
0105   return verboseLevel;
0106 }
0107
0108 inline void G4VIsotopeTable::SetVerboseLevel(G4int level)
0109 {
0110   verboseLevel = level;
0111 }
0112
0113 #endif