pdg_particle_tools.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-08-28
 * Last modified: 2015-08-30
 *
 * License:
 * Copyright 2015 F. Mauger
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   PDF particle code
 *
 * History:
 *
 */

#ifndef GENBB_HELP_PDG_PARTICLE_TOOLS_H
#define GENBB_HELP_PDG_PARTICLE_TOOLS_H

// Standard library:
#include <string>
#include <map>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/exception.h>
#include <datatools/i_tree_dump.h>

namespace genbb {

  namespace pdg {

    class particle : public datatools::i_tree_dumpable
    {
    public:

      enum particle_code {
        INVALID_CODE           =      0, 

        // Leptons:
        ELECTRON               =     11,
        POSITRON               =    -11,
        NEUTRINO_ELECTRON      =     12,
        ANTI_NEUTRINO_ELECTRON =    -12,
        MUON_MINUS             =     13,
        MUON_PLUS              =    -13,
        NEUTRINO_MUON          =     14,
        ANTI_NEUTRINO_MUON     =    -14,
        TAU_MINUS              =     15,
        TAU_PLUS               =    -15,
        NEUTRINO_TAU           =     16,
        ANTI_NEUTRINO_TAU      =    -16,

        // Bosons:
        GAMMA                  =     22,

        // Monte-Carlo
        MC_GEANTINO            =     81,
        MC_OPTICAL_PHOTON      =     82,
        MC_CERENKOV            =     82,
        MC_SCINTILLATION       =     82,
        MC_UNSPECIFIED         =    100,

        // Mesons:
        PION_ZERO              =    111,
        PION_PLUS              =    211,
        PION_MINUS             =   -211,
        KAON_ZERO_LONG         =    130,
        KAON_ZERO_SHORT        =    310,
        KAON_ZERO              =    311,
        ANTI_KAON_ZERO         =   -311,
        KAON_PLUS              =    321,
        KAON_MINUS             =   -321,
        ETA                    =    221,

        // Barions:
        PROTON                 =   2212,
        ANTI_PROTON            =  -2212,
        NEUTRON                =   2112,
        ANTI_NEUTRON           =  -2112,
        LAMBDA                 =   3122,
        ANTI_LAMBDA            =  -3122,
        SIGMA_PLUS             =   3222,
        ANTI_SIGMA_PLUS        =  -3222,
        SIGMA_ZERO             =   3212,
        ANTI_SIGMA_ZERO        =  -3212,
        SIGMA_MINUS            =   3112,
        ANTI_SIGMA_MINUS       =  -3112,
        XI_ZERO                =   3322,
        ANTI_XI_ZERO           =  -3322,
        XI_MINUS               =   3312,
        ANTI_XI_MINUS          =  -3312,
        OMEGA_MINUS            =   3334,
        ANTI_OMEGA_MINUS       =  -3334,

        // Ions:
        DEUTERON               =  1000010020,
        ANTI_DEUTERON          = -1000010020,
        TRITON                 =  1000010030,
        ANTI_TRITON            = -1000010030,
        HE3                    =  1000020030,
        ANTI_HE3               = -1000020030,
        ALPHA                  =  1000020040,
        ANTI_ALPHA             = -1000020040

      };

      particle();

      particle(int32_t pdg_code_,
               const std::string & name_,
               const std::string & latex_repr_);

      particle(int32_t pdg_code_,
               const std::string & name_,
               const std::string & alt_name_,
               const std::string & latex_repr_);

      virtual ~particle();

      bool is_valid() const;

      void reset();

      int32_t get_code() const;

      particle & set_code(int32_t);

      const std::string & get_name() const;

      particle & set_name(const std::string &);

      bool has_alt_name() const;

      const std::string & get_alt_name() const;

      particle & set_alt_name(const std::string &);

      const std::string & get_latex_repr() const;

      particle & set_latex_repr(const std::string &);

      const datatools::properties & get_auxiliaries() const;

      datatools::properties & grab_auxiliaries();

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_ = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

     static int32_t build_nuclear_code(int z_, int a_, int i_ = 0);

    private:

      int32_t     _code_;       
      std::string _name_;       
      std::string _alt_name_;   
      std::string _latex_repr_; 
      datatools::properties _auxiliaries_; 

    };

    class particle_registry : public datatools::i_tree_dumpable
    {

    public:

      typedef std::map<int32_t, particle> particle_dict_type;

      particle_registry(uint32_t flags_ = 0);

      ~particle_registry();

      void clear();

      particle & registration(const particle & part_);

      void unregistration(const std::string & name_);

      void unregistration(int32_t pdg_code_);

      bool has_particle(int32_t pdg_code_) const;

      const particle & get_particle(int32_t pdg_code_) const;

      bool has_particle_by_name(const std::string & name_) const;

      const particle & get_particle_by_name(const std::string & name_) const;

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_ = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

      void register_standard_particles();

      static particle_registry & system_registry();

      static const particle_registry & const_system_registry();

    private:

      particle_dict_type _records_; 

      static particle_registry & _access_system_registry_();

    };

  } // end of namespace pdg

} // end of namespace genbb

#endif // GENBB_HELP_PDG_PARTICLE_TOOLS_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --