PoPI::SymbolBase Class Reference

#include <PoPI.hpp>

Inheritance diagram for PoPI::SymbolBase:

Public Member Functions
	SymbolBase (HAPI::Node const &a_node, Particle_class a_class)
	~SymbolBase ()
std::string const &	symbol () const
std::size_t	addToSymbols (Database *a_DB)
bool	isParticle () const
Public Member Functions inherited from PoPI::Base
	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
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

Additional Inherited Members
Public Attributes inherited from PoPI::Base
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 SymbolBase instances.

Definition at line 706 of file PoPI.hpp.

Constructor & Destructor Documentation

SymbolBase()

PoPI::SymbolBase::SymbolBase	(	HAPI::Node const &	a_node,
		Particle_class	a_class )

Parameters

a_node	[in] The HAPI::Node to be parsed.
a_class	[in] The PoPI class for this.

Definition at line 110 of file PoPI_base.cc.

                                                                       :
        Base( a_node, PoPI_symbolChars, a_class ) {
 
}

Referenced by PoPI::Isotope::Isotope().

~SymbolBase()

PoPI::SymbolBase::~SymbolBase

(

)

Definition at line 118 of file PoPI_base.cc.

                         {
 
}

Member Function Documentation

addToSymbols()

std::size_t PoPI::SymbolBase::addToSymbols

(

Database *

a_DB

)

This method adds this to the m_symbolList member of a_DB.

Parameters

a_DB	[in] The PoPI::Database instance to add this to.

Returns

The index assigned to this by a_DB.

Definition at line 130 of file PoPI_base.cc.

                                                   {
 
    a_DB->addSymbol( this );
    return( index( ) );
}

isParticle()

bool PoPI::SymbolBase::isParticle ( ) const

inlinevirtual

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

Reimplemented from PoPI::Base.

Definition at line 715 of file PoPI.hpp.

{ return( false ); }

symbol()

std::string const & PoPI::SymbolBase::symbol ( ) const

inline

Returns the value of the symbol.

Definition at line 712 of file PoPI.hpp.

Referenced by PoPI::Database::addSymbol(), PoPI::ChemicalElement::toXMLList(), and PoPI::Isotope::toXMLList().

---

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

• PoPI.hpp
• PoPI_base.cc