Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
PoPI::Base Class Reference

#include <PoPI.hpp>

Inheritance diagram for PoPI::Base:

Public Member Functions

 Base (std::string const &a_id, Particle_class a_class)
 Base (HAPI::Node const &a_node, std::string const &a_label, Particle_class a_class)
virtual ~Base ()
std::string const & ID (void) const
std::size_t index (void) const
void setIndex (std::size_t a_index)
int intid () const
Particle_class Class (void) const
virtual bool isParticle () const
bool isAlias (void) const
bool isMetaStableAlias (void) const
bool isGaugeBoson () const
bool isLepton () const
bool isBaryon () const
bool isUnorthodox () const
bool isNucleus () const
bool isNuclide () const
bool isIsotope () const
bool isChemicalElement () const

Public Attributes

friend MetaStable
friend Alias
friend Baryon
friend GaugeBoson
friend Lepton
friend Nucleus
friend Nuclide
friend Unorthodox

Detailed Description

This class is the base class for all Particle and SymbolBase instances.

Definition at line 637 of file PoPI.hpp.

Constructor & Destructor Documentation

◆ Base() [1/2]

PoPI::Base::Base ( std::string const & a_id,
Particle_class a_class )
Parameters
a_id[in] The PoPs id for this.
a_class[in] The PoPI class for this.

Definition at line 23 of file PoPI_base.cc.

23 :
24 m_id( a_id ),
25 m_class( a_class ),
26 m_index( SIZE_MAX ),
27 m_intid( -1 ) {
28
29}

Referenced by PoPI::IDBase::IDBase(), PoPI::IDBase::IDBase(), and PoPI::SymbolBase::SymbolBase().

◆ Base() [2/2]

PoPI::Base::Base ( HAPI::Node const & a_node,
std::string const & a_label,
Particle_class a_class )

Constructor that parses an HAPI instance.

Parameters
a_node[in] The HAPI::Node to be parsed.
a_label[in] This is either id or symbol. That is, it is the name of the attribute in a_node whose value represents this m_id member.
a_class[in] The PoPI class for this.

Definition at line 39 of file PoPI_base.cc.

39 :
40 m_id( a_node.attribute( a_label.c_str( ) ).value( ) ),
41 m_class( a_class ),
42 m_index( SIZE_MAX ),
43 m_intid( -1 ) {
44
45}

◆ ~Base()

PoPI::Base::~Base ( )
virtual

Definition at line 50 of file PoPI_base.cc.

50 {
51
52}

Member Function Documentation

◆ Class()

Particle_class PoPI::Base::Class ( void ) const
inline

Returns the value of the m_class member of this.

Definition at line 656 of file PoPI.hpp.

Referenced by PoPI::Database::addSymbol().

◆ ID()

std::string const & PoPI::Base::ID ( void ) const
inline

Returns a const reference to the m_id member of this.

Definition at line 652 of file PoPI.hpp.

Referenced by PoPI::Database::add(), PoPI::Alias::Alias(), PoPI::Nuclide::calculateNuclideGammaBranchStateInfos(), PoPI::Database::chemicalElementSymbol(), PoPI::Nucleus::energy(), PoPI::GaugeBoson::GaugeBoson(), PoPI::Database::isotopeSymbol(), PoPI::Lepton::Lepton(), PoPI::Nuclide::massValue(), PoPI::Particle::massValue(), PoPI::MetaStable::MetaStable(), PoPI::Particle::Particle(), PoPI::particleA(), GIDI::ParticleInfo::ParticleInfo(), PoPI::particleZ(), PoPI::particleZA(), PoPI::Database::print(), GIDI::Map::Map::replacementTarget(), PoPI::SymbolBase::symbol(), PoPI::Alias::toXMLList(), PoPI::MetaStable::toXMLList(), PoPI::Particle::toXMLList(), and PoPI::Unorthodox::Unorthodox().

◆ index()

std::size_t PoPI::Base::index ( void ) const
inline

Returns the value of the m_index member of this.

Definition at line 653 of file PoPI.hpp.

Referenced by PoPI::IDBase::addToDatabase(), PoPI::SymbolBase::addToSymbols(), and PoPI::Database::print().

◆ intid()

int PoPI::Base::intid ( ) const
inline

Returns the value of the m_intid member.

Definition at line 655 of file PoPI.hpp.

Referenced by PoPI::Database::add(), PoPI::Nuclide::calculateNuclideGammaBranchStateInfos(), GIDI::GRIN::GRIN_continuumGammas::GRIN_continuumGammas(), and PoPI::Database::intid().

◆ isAlias()

bool PoPI::Base::isAlias ( void ) const
inline

Returns true if this is an Alias or MetaStable instance and false otherwise.

Definition at line 658 of file PoPI.hpp.

Referenced by PoPI::Database::add(), G4GIDI_target::G4GIDI_target(), GIDI::ParticleInfo::ParticleInfo(), and PoPI::Database::print().

◆ isBaryon()

bool PoPI::Base::isBaryon ( ) const
inline

Returns true if this is a Baryon instance and false otherwise.

Definition at line 665 of file PoPI.hpp.

◆ isChemicalElement()

bool PoPI::Base::isChemicalElement ( ) const
inline

Returns true if this is a ChemicalElement instance and false otherwise.

Definition at line 670 of file PoPI.hpp.

Referenced by PoPI::Database::chemicalElementSymbol(), PoPI::particleZ(), PoPI::particleZ(), PoPI::particleZA(), and GIDI::Map::Protare::Protare().

◆ isGaugeBoson()

bool PoPI::Base::isGaugeBoson ( ) const
inline

Returns true if this is a GaugeBoson instance and false otherwise.

Definition at line 663 of file PoPI.hpp.

◆ isIsotope()

bool PoPI::Base::isIsotope ( ) const
inline

Returns true if this is a Isotope instance and false otherwise.

Definition at line 669 of file PoPI.hpp.

Referenced by PoPI::Database::chemicalElementSymbol(), PoPI::Database::isotopeSymbol(), PoPI::particleA(), and PoPI::particleZ().

◆ isLepton()

bool PoPI::Base::isLepton ( ) const
inline

Returns true if this is a Lepton instance and false otherwise.

Definition at line 664 of file PoPI.hpp.

◆ isMetaStableAlias()

bool PoPI::Base::isMetaStableAlias ( void ) const
inline

Returns true if this is a MetaStable instance and false otherwise.

Definition at line 660 of file PoPI.hpp.

Referenced by isAlias(), and PoPI::particleMetaStableIndex().

◆ isNucleus()

bool PoPI::Base::isNucleus ( ) const
inline

Returns true if this is a Nucleus instance and false otherwise.

Definition at line 667 of file PoPI.hpp.

Referenced by PoPI::Database::chemicalElementSymbol(), PoPI::Database::isotopeSymbol(), PoPI::particleA(), PoPI::particleZ(), and GIDI::Map::Map::replacementTarget().

◆ isNuclide()

bool PoPI::Base::isNuclide ( ) const
inline

Returns true if this is a Nuclide instance and false otherwise.

Definition at line 668 of file PoPI.hpp.

Referenced by PoPI::Database::chemicalElementSymbol(), PoPI::Database::isotopeSymbol(), PoPI::particleA(), GIDI::ParticleInfo::ParticleInfo(), and PoPI::particleZ().

◆ isParticle()

virtual bool PoPI::Base::isParticle ( ) const
inlinevirtual

Returns true if this is a Particle and false it this is a ChemicalElement or Isotope instance.

Reimplemented in PoPI::SymbolBase.

Definition at line 657 of file PoPI.hpp.

Referenced by G4GIDI_target::G4GIDI_target(), PoPI::Database::intid(), GIDI::ParticleInfo::ParticleInfo(), and PoPI::Database::print().

◆ isUnorthodox()

bool PoPI::Base::isUnorthodox ( ) const
inline

Returns true if this is a Unorthodox instance and false otherwise.

Definition at line 666 of file PoPI.hpp.

◆ setIndex()

void PoPI::Base::setIndex ( std::size_t a_index)
inline

Sets the value of the m_index member of this to a_index.

Definition at line 654 of file PoPI.hpp.

Referenced by PoPI::Database::add(), and PoPI::Database::addSymbol().

Member Data Documentation

◆ Alias

friend PoPI::Base::Alias

Definition at line 674 of file PoPI.hpp.

◆ Baryon

friend PoPI::Base::Baryon

Definition at line 675 of file PoPI.hpp.

◆ GaugeBoson

friend PoPI::Base::GaugeBoson

Definition at line 676 of file PoPI.hpp.

◆ Lepton

friend PoPI::Base::Lepton

Definition at line 677 of file PoPI.hpp.

◆ MetaStable

friend PoPI::Base::MetaStable

Definition at line 673 of file PoPI.hpp.

◆ Nucleus

friend PoPI::Base::Nucleus

Definition at line 678 of file PoPI.hpp.

◆ Nuclide

friend PoPI::Base::Nuclide

Definition at line 679 of file PoPI.hpp.

◆ Unorthodox

friend PoPI::Base::Unorthodox

Definition at line 680 of file PoPI.hpp.

The documentation for this class was generated from the following files: