include/Geant4/G4INCLParticleSpecies.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 // INCL++ intra-nuclear cascade model
0027 // Alain Boudard, CEA-Saclay, France
0028 // Joseph Cugnon, University of Liege, Belgium
0029 // Jean-Christophe David, CEA-Saclay, France
0030 // Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
0031 // Sylvie Leray, CEA-Saclay, France
0032 // Davide Mancusi, CEA-Saclay, France
0033 //
0034 #define INCLXX_IN_GEANT4_MODE 1
0035
0036 #include "globals.hh"
0037
0038 /*
0039  * G4INCLParticleSpecies.hh
0040  *
0041  *  \date Nov 25, 2011
0042  * \author Davide Mancusi
0043  */
0044
0045 #ifndef G4INCLPARTICLESPECIES_HH_
0046 #define G4INCLPARTICLESPECIES_HH_
0047
0048 #include "G4INCLParticleType.hh"
0049 #include <string>
0050
0051 namespace G4INCL {
0052
0053   class ParticleSpecies {
0054     public:
0055       /// \brief Convert a string to a particle species
0056       ParticleSpecies() :
0057         theType(UnknownParticle),
0058         theA(0),
0059         theZ(0),
0060         theS(0)
0061     {}
0062       ParticleSpecies(std::string const &pS);
0063       ParticleSpecies(ParticleType const t);
0064       ParticleSpecies(const G4int A, const G4int Z);
0065       ParticleSpecies(const G4int A, const G4int Z, const G4int S);
0066
0067       ParticleType theType;
0068       G4int theA, theZ, theS;
0069
0070       /** \brief Set a PDG Code (MONTE CARLO PARTICLE NUMBERING)
0071        *
0072        * \param
0073        * \return integer (identifying number for each particle)
0074        */
0075       G4int getPDGCode() const;
0076
0077     private:
0078       /** \brief Parse a nuclide name
0079        *
0080        * Note: this function is UGLY. Look at it at your own peril.
0081        *
0082        * \param pS a normalised string (lowercase)
0083        */
0084       void parseNuclide(std::string const &pS);
0085
0086       /** \brief Parse an element name
0087        *
0088        * Note: this function is UGLY. Look at it at your own peril.
0089        *
0090        * \param pS a normalised string (lowercase)
0091        * \return true if the parsing succeeded
0092        */
0093       G4bool parseElement(std::string const &pS);
0094
0095       /** \brief Parse a IUPAC element name
0096        *
0097        * Note: this function is UGLY. Look at it at your own peril.
0098        *
0099        * \param s a normalised string (lowercase)
0100        * \return true if the parsing succeeded
0101        */
0102       G4bool parseIUPACElement(std::string const &s);
0103
0104   };
0105
0106 }
0107
0108 #endif /* G4INCLPARTICLESPECIES_HH_ */