PoPI::IDBase Class Reference

#include <PoPI.hpp>

Inheritance diagram for PoPI::IDBase:

Public Member Functions
	IDBase (std::string const &a_id, Particle_class a_class)
	IDBase (HAPI::Node const &a_node, Particle_class a_class)
virtual	~IDBase ()
std::size_t	addToDatabase (Database *a_DB)
double	massValue2 (Database const &a_DB, std::string const &a_unit) 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
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

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 Particle instances.

Definition at line 689 of file PoPI.hpp.

Constructor & Destructor Documentation

IDBase() [1/2]

PoPI::IDBase::IDBase	(	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 63 of file PoPI_base.cc.

                                                              :
        Base( a_id, a_class ) {
 
}

Referenced by PoPI::Alias::Alias(), and PoPI::Particle::Particle().

IDBase() [2/2]

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

Constructor that parses an HAPI instance.

Parameters

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

Definition at line 75 of file PoPI_base.cc.

                                                               :
        Base( a_node, PoPI_idChars, a_class ) {
 
}

~IDBase()

PoPI::IDBase::~IDBase ( )

virtual

Definition at line 83 of file PoPI_base.cc.

                 {
 
}

Member Function Documentation

addToDatabase()

std::size_t PoPI::IDBase::addToDatabase

(

Database *

a_DB

)

This method adds this to the m_list 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 95 of file PoPI_base.cc.

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

Referenced by PoPI::Alias::Alias(), PoPI::Baryon::Baryon(), PoPI::GaugeBoson::GaugeBoson(), PoPI::Lepton::Lepton(), PoPI::MetaStable::MetaStable(), PoPI::Nucleus::Nucleus(), PoPI::Nuclide::Nuclide(), and PoPI::Unorthodox::Unorthodox().

massValue2()

double PoPI::IDBase::massValue2	(	Database const &	a_DB,
		std::string const &	a_unit ) const

---

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

• PoPI.hpp
• PoPI_base.cc