#include <PoPI.hpp>

Public Member Functions
	Database ()
	Database (std::string const &a_fileName)
	Database (HAPI::Node const &a_database)
	~Database ()
LUPI::FormatVersion const &	formatVersion (void) const
std::string const &	name (void) const
std::string const &	version (void) const
std::vector< Alias * >	unresolvedAliases ()
std::size_t	numberOfUnresolvedAliases ()
std::vector< std::string >	unresolvedAliasIds () const
std::vector< Alias * > &	aliases ()
void	addFile (char const *a_fileName, bool a_warnIfDuplicate)
void	addFile (std::string const &a_fileName, bool a_warnIfDuplicate)
void	addDatabase (std::string const &a_string, bool a_warnIfDuplicate)
void	addDatabase (HAPI::Node const &a_database, bool a_warnIfDuplicate)
void	addAlias (Alias *a_alias)
std::string::size_type	size (void) const
ParticleList const &	list ()
SymbolList const &	symbolList ()
std::size_t	operator[] (std::string const &a_id) const
template<typename T>
T const &	get (std::string const &a_id) const
template<typename T>
T const &	get (std::size_t a_index) const
Particle const &	particle (std::string const &a_id) const
Particle const &	particle (std::size_t a_index) const
IDBase const &	idBase (std::string const &a_id) const
IDBase const &	idBase (std::size_t &a_index) const
ParticleList const &	particleList () const
SymbolList	symbolList () const
bool	exists (std::string const &a_id) const
bool	exists (std::size_t a_index) const
bool	existsIntid (int a_intid) const
Suite< ChemicalElement, Database > const &	chemicalElements () const
bool	isParticle (std::string const &a_id) const
bool	isParticle (std::size_t a_index) const
bool	isAlias (std::string const &a_id) const
bool	isAlias (std::size_t a_index) const
bool	isMetaStableAlias (std::string const &a_id) const
bool	isMetaStableAlias (std::size_t a_index) const
std::vector< std::string >	aliasReferences (std::string const &a_id)
std::string	final (std::string const &a_id, bool a_returnAtMetaStableAlias=false) const
std::size_t	final (std::size_t a_index, bool a_returnAtMetaStableAlias=false) const
std::string	chemicalElementSymbol (std::string const &a_id) const
std::string	isotopeSymbol (std::string const &a_id) const
int	intid (std::string const &a_id) const
int	intid (std::size_t a_index) const
std::size_t	indexFromIntid (int a_intid) const
std::size_t	add (Base *a_item)
std::size_t	addSymbol (SymbolBase *a_item)
void	calculateNuclideGammaBranchStateInfos (NuclideGammaBranchStateInfos &a_nuclideGammaBranchStateInfos, Database const *a_pops2, std::vector< std::string > &a_extraGammaBranchStates) const
void	calculateNuclideGammaBranchStateInfos2 (NuclideGammaBranchStateInfos &a_nuclideGammaBranchStateInfos) const
double	massValue (std::string const &a_id, std::string const &a_unit) const
void	saveAs (std::string const &a_fileName) const
void	toXMLList (std::vector< std::string > &a_XMLList, std::string const &a_indent1) const
void	print (bool a_printIndices)
template<typename T>
T const &	get (std::size_t a_index) const
template<typename T>
T const &	get (std::string const &a_id) const

Detailed Description

The main class for storing PoPs data.

Definition at line 1128 of file PoPI.hpp.

Constructor & Destructor Documentation

◆ Database() [1/3]

PoPI::Database::Database ( )

Database constructor for an initial empty PoPs database.

Definition at line 37 of file PoPI_database.cc.

                    : 
        m_gaugeBosons( PoPI_gaugeBosonsChars ),
        m_leptons( PoPI_leptonsChars ),
        m_baryons( PoPI_baryonsChars ),
        m_chemicalElements( PoPI_chemicalElementsChars ),
        m_unorthodoxes( PoPI_unorthodoxesChars ) {
 
}

Referenced by calculateNuclideGammaBranchStateInfos().

◆ Database() [2/3]

PoPI::Database::Database ( std::string const & a_fileName )

Database constructor for a PoPs database with data read from the file a_fileName.

Parameters

a_fileName [in] The PoPs file to read in.

Definition at line 52 of file PoPI_database.cc.

                                                : 
        m_gaugeBosons( PoPI_gaugeBosonsChars ),
        m_leptons( PoPI_leptonsChars ),
        m_baryons( PoPI_baryonsChars ),
        m_chemicalElements( PoPI_chemicalElementsChars ),
        m_unorthodoxes( PoPI_unorthodoxesChars ) {
 
    addFile( a_fileName, false );
}

◆ Database() [3/3]

PoPI::Database::Database ( HAPI::Node const & a_database )

Database constructor for a PoPs database with data read from a HAPI::Node instance. This method is mainly for internal use.

Parameters

a_database [in] A HAPI::Node instance containing the data to parse.

Definition at line 69 of file PoPI_database.cc.

                                               :
        m_gaugeBosons( PoPI_gaugeBosonsChars ),
        m_leptons( PoPI_leptonsChars ),
        m_baryons( PoPI_baryonsChars ),
        m_chemicalElements( PoPI_chemicalElementsChars ),
        m_unorthodoxes( PoPI_unorthodoxesChars ) {
 
    addDatabase( a_database, false );
}

◆ ~Database()

PoPI::Database::~Database ( )

Destructor for a PoPI::Database instance.

Definition at line 215 of file PoPI_database.cc.

                     {
 
    for( std::vector<Alias *>::iterator iter = m_aliases.begin( ); iter != m_aliases.end( ); ++iter ) delete *iter;
}

Member Function Documentation

◆ add()

std::size_t PoPI::Database::add ( Base * a_item )

This method adds a PoPI::Base instance to this and returns the unique index for it.

Parameters

a_item [in] The PoPI::Base instance to add to this.

Returns: The index for the added PoPI::Base instance.

Definition at line 493 of file PoPI_database.cc.

                                      {
 
    std::size_t index = m_list.size( );
 
    m_idsMap[a_item->ID( )] = index;
    m_list.push_back( a_item );
    a_item->setIndex( index );
 
    if( a_item->intid( ) > 0 ) m_intidsMap[a_item->intid( )] = index;
 
    if( a_item->isAlias( ) ) m_unresolvedAliases.push_back( (Alias *) a_item );
    return( index );
}

Referenced by addSymbol(), and PoPI::IDBase::addToDatabase().

◆ addAlias()

void PoPI::Database::addAlias ( Alias * a_alias )

inline

Added the Alias a_alias to this.

Definition at line 1170 of file PoPI.hpp.

◆ addDatabase() [1/2]

void PoPI::Database::addDatabase	(	HAPI::Node const &	a_database,
		bool	a_warnIfDuplicate )

◆ addDatabase() [2/2]

void PoPI::Database::addDatabase	(	std::string const &	a_string,
		bool	a_warnIfDuplicate )

Adds the contents of the a_string to this. a_string must be an XML string starting with an PoPs XML node (i.e., element).

Parameters

a_string	[in] A std::string instance of PoPs data in an XML format.
a_warnIfDuplicate	[in] This argument is currently not used.

Definition at line 114 of file PoPI_database.cc.

                                                                              {
 
    // a_string must contain a complete & well-formed XML document
    pugi::xml_document doc;
 
    pugi::xml_parse_result result = doc.load_string( a_string.c_str( ) );
    if( result.status != pugi::status_ok ) {
        char Msg[MsgSize+1];
 
        snprintf( Msg, MsgSize, "ERROR: in file '%s' in method '%s': %s.", __FILE__, __func__, result.description( ) );
        throw Exception( Msg );
    }
 
    HAPI::PugiXMLNode *database_internal = new HAPI::PugiXMLNode(doc.first_child( ));
    HAPI::Node database(database_internal);
    addDatabase( database, a_warnIfDuplicate );
}

Referenced by addDatabase(), addFile(), and Database().

◆ addFile() [1/2]

void PoPI::Database::addFile	(	char const *	a_fileName,
		bool	a_warnIfDuplicate )

Adds the contents of the file a_fileName to this.

Parameters

a_fileName	[in] The PoPs file to get data from.
a_warnIfDuplicate	[in] This argument is currently not used.

Definition at line 98 of file PoPI_database.cc.

                                                                       {
 
    HAPI::File *doc = new HAPI::PugiXMLFile( a_fileName, "Database::addFile" );
    HAPI::Node database = doc->first_child( );
    addDatabase( database, a_warnIfDuplicate );
    delete doc;
}

Referenced by addFile(), and Database().

◆ addFile() [2/2]

void PoPI::Database::addFile	(	std::string const &	a_fileName,
		bool	a_warnIfDuplicate )

Adds the contents of the file a_fileName to this.

Parameters

a_fileName	[in] The PoPs file to get data from.
a_warnIfDuplicate	[in] This argument is currently not used.

Definition at line 86 of file PoPI_database.cc.

                                                                            {
 
    addFile( a_fileName.c_str( ), a_warnIfDuplicate );
}

◆ addSymbol()

std::size_t PoPI::Database::addSymbol ( SymbolBase * a_item )

This method adds a PoPI::SymbolBase instance to this and returns the unique index for it.

Parameters

a_item [in] The PoPI::SymbolBase instance to add to this.

Returns: The index for the added PoPI::SymbolBase instance.

Definition at line 516 of file PoPI_database.cc.

                                                  {
 
    if( a_item->Class( ) == Particle_class::chemicalElement ) return( this->add( a_item ) );
 
    std::size_t index = m_symbolList.size( );
 
    m_symbolMap[a_item->symbol( )] = index;
    m_symbolList.push_back( a_item );
    a_item->setIndex( index );
 
    return( index );
}

Referenced by PoPI::SymbolBase::addToSymbols().

◆ aliases()

std::vector< Alias * > & PoPI::Database::aliases ( )

inline

Returns a const reference to the m_aliases variable of this.

Definition at line 1164 of file PoPI.hpp.

◆ aliasReferences()

std::vector< std::string > PoPI::Database::aliasReferences ( std::string const & a_id )

Returns a std::vector of std::string's of all aliases in this that resolve to a_id.

Parameters

a_id	[in] A particle's id whose.

Returns: Vector of alias ids.

Definition at line 307 of file PoPI_database.cc.

                                                                      {
 
    std::vector<std::string> ids;
 
    for( auto aliasIter = m_aliases.begin( ); aliasIter != m_aliases.end( ); ++aliasIter ) {
        if( final( (*aliasIter)->pid( ) ) == a_id ) ids.push_back( (*aliasIter)->ID( ) );
    }
 
    return( ids );
}

◆ calculateNuclideGammaBranchStateInfos()

void PoPI::Database::calculateNuclideGammaBranchStateInfos	(	NuclideGammaBranchStateInfos &	a_nuclideGammaBranchStateInfos,
		Database const *	a_pops2,
		std::vector< std::string > &	a_extraGammaBranchStates ) const

This method calculates nuclide gamma branching infomation and adds it to a_nuclideGammaBranchStateInfos.

Parameters

a_nuclideGammaBranchStateInfos	[in] The NuclideGammaBranchStateInfos instance to added nuclide gamma branching infomation to.
a_pops2	A second PoPs used for storing GRIN added particles.
a_extraGammaBranchStates	Any additional nuclide needed by GRIN. Currently, one the capture residual.

Definition at line 537 of file PoPI_database.cc.

                                                                       {
 
 
    calculateNuclideGammaBranchStateInfos2( a_nuclideGammaBranchStateInfos );
    if( a_pops2 != nullptr ) {
        a_pops2->calculateNuclideGammaBranchStateInfos2( a_nuclideGammaBranchStateInfos );
        for( auto iter = a_extraGammaBranchStates.begin( ); iter != a_extraGammaBranchStates.end( ); ++iter ) {
            PoPI::Nuclide const &nuclide = a_pops2->get<PoPI::Nuclide>( *iter );
            nuclide.calculateNuclideGammaBranchStateInfos( *a_pops2, a_nuclideGammaBranchStateInfos, true );
        }
    }
 
    std::vector<NuclideGammaBranchStateInfo *> &nuclideGammaBranchStateInfos = a_nuclideGammaBranchStateInfos.nuclideGammaBranchStateInfos( );
    for( std::size_t i1 = 0; i1 < nuclideGammaBranchStateInfos.size( ); ++i1 ) {
        NuclideGammaBranchStateInfo *nuclideGammaBranchStateInfo = nuclideGammaBranchStateInfos[i1];
 
        nuclideGammaBranchStateInfo->calculateDerivedData( a_nuclideGammaBranchStateInfos );
    }
}

◆ calculateNuclideGammaBranchStateInfos2()

void PoPI::Database::calculateNuclideGammaBranchStateInfos2 ( NuclideGammaBranchStateInfos & a_nuclideGammaBranchStateInfos ) const

This method calculates nuclide gamma branching infomation and adds it to a_nuclideGammaBranchStateInfos.

Parameters

a_nuclideGammaBranchStateInfos [in] The NuclideGammaBranchStateInfos instance to added nuclide gamma branching infomation to.

Definition at line 564 of file PoPI_database.cc.

                                                                                                                          {
 
    for( std::size_t i1 = 0; i1 <  m_chemicalElements.size( ); ++i1 ) {
        ChemicalElement const &chemicalElement = m_chemicalElements[i1];
 
        chemicalElement.calculateNuclideGammaBranchStateInfos( *this, a_nuclideGammaBranchStateInfos );
    }
}

Referenced by calculateNuclideGammaBranchStateInfos().

◆ chemicalElements()

Suite< ChemicalElement, Database > const & PoPI::Database::chemicalElements ( ) const

inline

Returns a const reference to the m_chemicalElements variable of this.

Definition at line 1189 of file PoPI.hpp.

◆ chemicalElementSymbol()

std::string PoPI::Database::chemicalElementSymbol ( std::string const & a_id ) const

This method returns the chemical element symbol for a_id if it is a PoPs id for a chemicalElement, isotope, nuclide, or nucleus object. Otherwise, it returns an empty string. The PoPs id a_id must be in this.

Parameters

a_id	[in] A particle's id whose chemical element symbol is requested.

Returns: The string for the chemical element symbol.

Definition at line 365 of file PoPI_database.cc.

                                                                       {
 
    std::string symbol1;
    Base const *base = nullptr;
 
    auto iter = m_idsMap.find( a_id );
    if( iter != m_idsMap.end( ) ) {
        std::string finalId = final( a_id );
        iter = m_idsMap.find( finalId );
        base = m_list[iter->second]; }
    else {
        auto iter2 = m_symbolMap.find( a_id );
        if( iter2 != m_symbolMap.end( ) ) base = m_symbolList[iter2->second];
    }
 
    if( base != nullptr ) {
        if( base->isNucleus( ) ) base = static_cast<Nucleus const *>( base )->nuclide( );
        if( base->isNuclide( ) ) base = static_cast<Nuclide const *>( base )->isotope( );
        if( base->isIsotope( ) ) base = static_cast<Isotope const *>( base )->chemicalElement( );
        if( base->isChemicalElement( ) ) symbol1 = base->ID( );
    }
 
    return( symbol1 );
}

◆ exists() [1/2]

bool PoPI::Database::exists ( std::size_t a_index ) const

Returns true if the specified index is value and false otherwise. This is, if a particle exists within this with index a_index.

Parameters

a_index [in] A particle index to test.

Returns: true is the specified index is valid and false otherwise.

Definition at line 266 of file PoPI_database.cc.

                                               {
 
    if( a_index >= m_list.size( ) ) return( false );
    return( true );
}

◆ exists() [2/2]

bool PoPI::Database::exists ( std::string const & a_id ) const

Returns true if the specified id exists within this and false otherwise.

Parameters

a_id	[in] A particle id to test.

Returns: true is the specified id exists in this and false otherwise.

Definition at line 280 of file PoPI_database.cc.

                                                   {
 
    auto iter = m_idsMap.find( a_id );
    return( iter != m_idsMap.end( ) );
}

Referenced by intid(), intid(), MCGIDI::MCGIDI_popsIndex(), GIDI::ParticleInfo::ParticleInfo(), and GIDI::Map::Map::replacementTarget().

◆ existsIntid()

bool PoPI::Database::existsIntid ( int a_intid ) const

Returns true if the specified intid exists within this and false otherwise.

Parameters

a_intid [in] A particle's intidd to test.

Returns: true is the specified intid exists in this and false otherwise.

Definition at line 294 of file PoPI_database.cc.

                                              {
 
    return( m_intidsMap.find( a_intid ) != m_intidsMap.end( ) );
}

◆ final() [1/2]

std::size_t PoPI::Database::final	(	std::size_t	a_index,
		bool	a_returnAtMetaStableAlias = false ) const

This method resolves aliases to return an actual particle specified by a_index. That is, if a_index is an alias, then its referenced particle is returned. However, if a_returnAtMetaStableAlias is true and a meta-stable is found while resolving a_index, the then meta-stable index will be returned.

Parameters

a_index	[in] A particle's index whose resolved particle index is requested.
a_returnAtMetaStableAlias	[in] If true, the resolving will stop if a meta-stable is found.

Returns: The revolved index for a_index.

Definition at line 347 of file PoPI_database.cc.

                                                                                   {
 
    while( isAlias( a_index ) ) {
        if( a_returnAtMetaStableAlias && isMetaStableAlias( a_index ) ) break;
        a_index = ((Alias *) m_list[a_index])->pidIndex( );
    }
    return( a_index );
}

◆ final() [2/2]

std::string PoPI::Database::final	(	std::string const &	a_id,
		bool	a_returnAtMetaStableAlias = false ) const

This method resolves aliases to return an actual particle specified by a_id. That is, if a_id is an alias, then its referenced particle is returned. However, if a_returnAtMetaStableAlias is true and a meta-stable is found while resolving a_id, then the meta-stable id will be returned.

Parameters

a_id	[in] A particle's id whose resolved particle id is requested.
a_returnAtMetaStableAlias	[in] If true, the resolving will stop if a meta-stable is found.

Returns: The revolved id for a_id.

Definition at line 329 of file PoPI_database.cc.

                                                                                       {
 
    std::size_t index( final( (*this)[a_id], a_returnAtMetaStableAlias ) );
 
    return( m_list[index]->ID( ) );
}

Referenced by PoPI::particleA(), PoPI::particleA(), PoPI::particleMetaStableIndex(), PoPI::particleMetaStableIndex(), PoPI::particleZ(), PoPI::particleZ(), PoPI::particleZA(), PoPI::particleZA(), and GIDI::Map::Map::replacementTarget().

◆ formatVersion()

LUPI::FormatVersion const & PoPI::Database::formatVersion ( void ) const

inline

Returns a const reference to the m_formatVersion variable of this.

Definition at line 1157 of file PoPI.hpp.

◆ get() [1/4]

template<typename T>

T const & PoPI::Database::get ( std::size_t a_index ) const

Returns the partile in this that has index a_index.

Parameters

a_index [in] The index of the particle to return.

Returns: A const reference to the particle at index a_index.

Definition at line 1233 of file PoPI.hpp.

                                                                     {
 
    Base *particle = m_list[a_index];
    if( particle == nullptr ) throw std::range_error( std::string( "particle not in database" ) );
    T const *object = dynamic_cast<T const *>( particle );
    if( object == nullptr ) throw std::bad_cast( );
 
    return( *object );
}

◆ get() [2/4]

template<typename T>

T const & PoPI::Database::get ( std::size_t a_index ) const

◆ get() [3/4]

template<typename T>

T const & PoPI::Database::get ( std::string const & a_id ) const

Returns the partile in this that has index a_index.

Parameters

a_id	[in] The PoPs id of the particle to return.

Returns: A const reference to the particle with id a_id.

Definition at line 1251 of file PoPI.hpp.

                                                                         {
 
    auto index = (*this)[a_id];
    Base *particle = m_list[index];
    T const *object = dynamic_cast<T const *>( particle );
    if( object == nullptr ) throw std::bad_cast( );
 
    return( *object );
}

◆ get() [4/4]

template<typename T>

T const & PoPI::Database::get ( std::string const & a_id ) const

◆ idBase() [1/2]

IDBase const & PoPI::Database::idBase ( std::size_t & a_index ) const

inline

Returns a const reference to a IDBase instance with id a_index.

Definition at line 1181 of file PoPI.hpp.

◆ idBase() [2/2]

IDBase const & PoPI::Database::idBase ( std::string const & a_id ) const

inline

Returns a const reference to a IDBase instance with id a_id.

Definition at line 1180 of file PoPI.hpp.

Referenced by intid().

◆ indexFromIntid()

std::size_t PoPI::Database::indexFromIntid ( int a_intid ) const

Returns the index for particle with intid a_intid or -1 if a_intid is not in this.

Parameters

a_index [in] A particle's index whose index is requested.

Returns: The intid for a_index or -1 if a_index not in this.

Definition at line 475 of file PoPI_database.cc.

                                                      {
 
    auto iter = m_intidsMap.find( a_intid );
    if( iter == m_intidsMap.end( ) ) {
        throw Exception( "Intid " + LUPI::Misc::argumentsToString( "%d", a_intid ) + " not in pops" );
    }
 
    return( iter->second );
}

◆ intid() [1/2]

int PoPI::Database::intid ( std::size_t a_index ) const

Returns the intid for particle with index a_index or -1 if a_index is not in this.

Parameters

a_index [in] A particle's index whose index is requested.

Returns: The intid for a_index or -1 if a_index not in this.

Definition at line 451 of file PoPI_database.cc.

                                             {
 
    int intid2 = -1;
 
    if( exists( a_index ) ) {
        Base const &base = get<Base const>( a_index );
 
        if( base.isParticle( ) ) {
            IDBase const &idBase = static_cast<IDBase const &>( base );
            intid2 =  idBase.intid( );
        }
    }
 
    return( intid2 );
}

◆ intid() [2/2]

int PoPI::Database::intid ( std::string const & a_id ) const

Returns the intid for particle a_id or -1 if a_id is not in this.

Parameters

a_id	[in] A particle's id whose intid is requested.

Returns: The intid for a_id or -1 if a_id not in this.

Definition at line 431 of file PoPI_database.cc.

                                                 {
 
    int intid2 = -1;
 
    if( exists( a_id ) ) {
        Base const &base = get<Base const>( a_id );
        intid2 =  base.intid( );
    }
 
    return( intid2 );
}

Referenced by MCGIDI::MCGIDI_popsIntid().

◆ isAlias() [1/2]

bool PoPI::Database::isAlias ( std::size_t a_index ) const

inline

Returns true if a_index is an alias and false otherwise.

Definition at line 1195 of file PoPI.hpp.

Referenced by isAlias().

◆ isAlias() [2/2]

bool PoPI::Database::isAlias ( std::string const & a_id ) const

inline

Returns true if a_id is an alias and false otherwise.

Definition at line 1194 of file PoPI.hpp.

Referenced by final(), and isAlias().

◆ isMetaStableAlias() [1/2]

bool PoPI::Database::isMetaStableAlias ( std::size_t a_index ) const

inline

Returns true if a_index is a meta-stable and false otherwise.

Definition at line 1198 of file PoPI.hpp.

Referenced by isMetaStableAlias().

◆ isMetaStableAlias() [2/2]

bool PoPI::Database::isMetaStableAlias ( std::string const & a_id ) const

inline

Returns true if a_id is a meta-stable and false otherwise.

Definition at line 1196 of file PoPI.hpp.

Referenced by final(), and isMetaStableAlias().

◆ isotopeSymbol()

std::string PoPI::Database::isotopeSymbol ( std::string const & a_id ) const

This method returns the isotope symbol for a_id if it is a PoPs id for an isotope, nuclide, or nucleus object. Otherwise, it returns an empty string. The PoPs id a_id must be in this.

Parameters

a_id	[in] A particle's id whose isotope symbol is requested.

Returns: The string for the isopte symbol.

Definition at line 399 of file PoPI_database.cc.

                                                               {
    
    std::string symbol1;
    Base const *base = nullptr;
 
    auto iter = m_idsMap.find( a_id );
    if( iter != m_idsMap.end( ) ) {
        std::string finalId = final( a_id );
        iter = m_idsMap.find( finalId );
        base = m_list[iter->second]; }
    else {
        auto iter2 = m_symbolMap.find( a_id );
        if( iter2 != m_symbolMap.end( ) ) base = m_symbolList[iter2->second];
    }
    
    if( base != nullptr ) {
        if( base->isNucleus( ) ) base = static_cast<Nucleus const *>( base )->nuclide( );
        if( base->isNuclide( ) ) base = static_cast<Nuclide const *>( base )->isotope( );
        if( base->isIsotope( ) ) symbol1 = base->ID( );
    }
 
    return( symbol1 );
}

◆ isParticle() [1/2]

bool PoPI::Database::isParticle ( std::size_t a_index ) const

inline

Returns true if a_index is a particle and false otherwise.

Definition at line 1193 of file PoPI.hpp.

Referenced by isParticle().

◆ isParticle() [2/2]

bool PoPI::Database::isParticle ( std::string const & a_id ) const

inline

Returns true if a_id is a particle and false otherwise.

Definition at line 1192 of file PoPI.hpp.

Referenced by isParticle(), and GIDI::Map::Map::replacementTarget().

◆ list()

ParticleList const & PoPI::Database::list ( )

inline

Returns a const reference to the m_list member.

Definition at line 1173 of file PoPI.hpp.

◆ massValue()

double PoPI::Database::massValue	(	std::string const &	a_id,
		std::string const &	a_unit ) const

This method returns the mass of the particle/alias with id a_id. Currently, a_unit is ignored and the mass is returned in unit of amu.

Parameters

a_id	[in] The PoPs id of the particle/alias.file to write this to.
a_unit	[in] The unit of the returned mass.

Definition at line 581 of file PoPI_database.cc.

                                                                                 {
 
    Particle const &particle2 = particle( final( a_id ) );
 
    return( particle2.massValue( a_unit ) );
}

◆ name()

std::string const & PoPI::Database::name ( void ) const

inline

Returns a const reference to the m_name variable of this.

Definition at line 1158 of file PoPI.hpp.

◆ numberOfUnresolvedAliases()

std::size_t PoPI::Database::numberOfUnresolvedAliases ( )

inline

Returns the number of unresolved aliases.

Definition at line 1162 of file PoPI.hpp.

◆ operator[]()

std::size_t PoPI::Database::operator[] ( std::string const & a_id ) const

Internally, PoPI::Database stores a unique integer (called an index) for each particle in this. This method returns the the index for the specified particle.

Parameters

a_id	[in] The PoPs id for the specified particle.

Returns: The internal index for the specified particle.

Definition at line 246 of file PoPI_database.cc.

                                                            {
 
    auto iter = m_idsMap.find( a_id );
    if( iter == m_idsMap.end( ) ) {
        std::string errorMessage( "particle '" + a_id + "' not in database -3." );
        throw Exception( errorMessage );
    }
 
    return( iter->second );
}

◆ particle() [1/2]

Particle const & PoPI::Database::particle ( std::size_t a_index ) const

inline

Returns a const reference to the particle with index a_index.

Definition at line 1179 of file PoPI.hpp.

◆ particle() [2/2]

Particle const & PoPI::Database::particle ( std::string const & a_id ) const

inline

Returns a const reference to the particle with id a_id.

Definition at line 1178 of file PoPI.hpp.

Referenced by get(), get(), massValue(), print(), and GIDI::Map::Map::replacementTarget().

◆ particleList()

ParticleList const & PoPI::Database::particleList ( ) const

inline

Returns a const reference to the m_list variable of this.

Definition at line 1182 of file PoPI.hpp.

◆ print()

void PoPI::Database::print ( bool a_printIndices )

Prints a brief outline of the contents of this.

Parameters

a_printIndices [in] If true, each particles index is also printed.

Definition at line 647 of file PoPI_database.cc.

                                          {
 
    for( auto iter = m_idsMap.begin( ); iter != m_idsMap.end( ); ++iter ) {
        std::string label( iter->first );
        std::size_t index = iter->second;
        Base *item = m_list[index];
        std::string is_alias( "" );
        std::string mass( "" );
 
        if( item->isAlias( ) ) {
            is_alias = " is an alias (final is label = '";
            std::size_t finalIndex = final( index );
            IDBase const &myfinal = get<IDBase>( finalIndex );
            is_alias += std::string( myfinal.ID( ) );
            is_alias += std::string( "')" ); }
        else if( item->isParticle( ) ) {
            Particle *particle = (Particle *) item;
 
            try {
                double dmass = particle->massValue( "amu" );
                mass = LUPI::Misc::argumentsToString( "  mass = %e amu", dmass ); }
            catch (...) {
                mass = " particle has no mass data.";
            }
        }
 
        std::cout << iter->first << " (" << item->ID( ) << ") --> ";
        if( a_printIndices ) std::cout << index << " (" << item->index( ) << ")";
        std::cout << is_alias << mass << std::endl;
    }
}

◆ saveAs()

void PoPI::Database::saveAs ( std::string const & a_fileName ) const

Writes an XML version of this to the file a_fileName.

Parameters

a_fileName [in] The file to write this to.

Definition at line 594 of file PoPI_database.cc.

                                                         {
 
    std::string indent1( "" );
    std::vector<std::string> XMLList;
 
    XMLList.push_back( "<?xml version=\"1.0\"?>" );
    toXMLList( XMLList, indent1 );
 
    std::ofstream fileio;
    fileio.open( a_fileName.c_str( ) );
    for( std::vector<std::string>::iterator iter = XMLList.begin( ); iter != XMLList.end( ); ++iter ) {
        fileio << *iter << std::endl;
    }
    fileio.close( );
}

◆ size()

std::string::size_type PoPI::Database::size ( void ) const

inline

Returns the number of particle in this.

Definition at line 1172 of file PoPI.hpp.

◆ symbolList() [1/2]

SymbolList const & PoPI::Database::symbolList ( )

inline

Returns a const reference to the m_symbolList member.

Definition at line 1174 of file PoPI.hpp.

◆ symbolList() [2/2]

SymbolList PoPI::Database::symbolList ( ) const

inline

Returns a const reference to the m_symbolList variable of this.

Definition at line 1183 of file PoPI.hpp.

◆ toXMLList()

void PoPI::Database::toXMLList	(	std::vector< std::string > &	a_XMLList,
		std::string const &	a_indent1 ) const

Adds the contents of this to a_XMLList where each item in a_XMLList is one line (without linefeeds) to output as an XML representation of this.

Parameters

a_XMLList	[in] The list to add an XML output representation of this to.
a_indent1	[in] The amount of indentation to added to each line added to a_XMLList.

Definition at line 617 of file PoPI_database.cc.

                                                                                            {
 
    std::string indent2 = a_indent1 + "  ";
    std::string indent3 = indent2 + "  ";
 
    std::string header1 = a_indent1 + "<PoPs name=\"" + m_name + "\" version=\"" + m_version + "\" format=\"" + m_formatVersion.format( ) + "\">";
    a_XMLList.push_back( std::move( header1 ) );
 
    if( m_aliases.size( ) > 0 ) {
        std::string header2 = indent2 + "<" + PoPI_aliasesChars + ">";
        a_XMLList.push_back( std::move( header2 ) );
        for( std::vector<Alias *>::const_iterator iter = m_aliases.begin( ); iter != m_aliases.end( ); ++iter )
            (*iter)->toXMLList( a_XMLList, indent3 );
        appendXMLEnd( a_XMLList, PoPI_aliasesChars );
    }
    m_gaugeBosons.toXMLList( a_XMLList, indent2 );
    m_leptons.toXMLList( a_XMLList, indent2 );
    m_baryons.toXMLList( a_XMLList, indent2 );
    m_unorthodoxes.toXMLList( a_XMLList, indent2 );
    m_chemicalElements.toXMLList( a_XMLList, indent2 );
 
    appendXMLEnd( a_XMLList, PoPI_PoPsChars );
}

Referenced by saveAs().

◆ unresolvedAliases()

std::vector< Alias * > PoPI::Database::unresolvedAliases ( )

inline

Returns a reference to the m_unresolvedAliases member of this.

Definition at line 1161 of file PoPI.hpp.

◆ unresolvedAliasIds()

std::vector< std::string > PoPI::Database::unresolvedAliasIds ( ) const

This method returns the list of ids for the aliases with unresolved pids.

Returns: A std::vector<std::string> of the ids of the aliases with unresolved pids.

Definition at line 226 of file PoPI_database.cc.

                                                         {
 
    std::vector<std::string> ids;
 
    for( std::vector<Alias *>::const_iterator iter = m_unresolvedAliases.begin( ); iter != m_unresolvedAliases.end( ); ++iter ) {
        ids.push_back( (*iter)->ID( ) );
    }
 
    return( ids );
}

◆ version()

std::string const & PoPI::Database::version ( void ) const

inline

Returns a const reference to the m_version variable of this.

Definition at line 1159 of file PoPI.hpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Database() [1/3]

◆ Database() [2/3]

◆ Database() [3/3]

◆ ~Database()

Member Function Documentation

◆ add()

◆ addAlias()

◆ addDatabase() [1/2]

◆ addDatabase() [2/2]

◆ addFile() [1/2]

◆ addFile() [2/2]

◆ addSymbol()

◆ aliases()

◆ aliasReferences()

◆ calculateNuclideGammaBranchStateInfos()

◆ calculateNuclideGammaBranchStateInfos2()

◆ chemicalElements()

◆ chemicalElementSymbol()

◆ exists() [1/2]

◆ exists() [2/2]

◆ existsIntid()

◆ final() [1/2]

◆ final() [2/2]

◆ formatVersion()

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ idBase() [1/2]

◆ idBase() [2/2]

◆ indexFromIntid()

◆ intid() [1/2]

◆ intid() [2/2]

◆ isAlias() [1/2]

◆ isAlias() [2/2]

◆ isMetaStableAlias() [1/2]

◆ isMetaStableAlias() [2/2]

◆ isotopeSymbol()

◆ isParticle() [1/2]

◆ isParticle() [2/2]

◆ list()

◆ massValue()

◆ name()

◆ numberOfUnresolvedAliases()

◆ operator[]()

◆ particle() [1/2]

◆ particle() [2/2]

◆ particleList()

◆ print()

◆ saveAs()

◆ size()

◆ symbolList() [1/2]

◆ symbolList() [2/2]

◆ toXMLList()

◆ unresolvedAliases()

◆ unresolvedAliasIds()

◆ version()