G4GIDI.hh File Reference

#include <vector>
#include <list>
#include <G4Types.hh>
#include <MCGIDI.hpp>

Go to the source code of this file.

Classes
class	G4GIDI_Product
class	G4GIDI_target
class	G4GIDI

Macros
#define	channelID   std::string

Functions
std::string	G4GIDI_version ()
int	G4GIDI_versionMajor ()
int	G4GIDI_versionMinor ()
int	G4GIDI_versionPatchLevel ()
std::string	G4GIDI_GitHash ()
void	G4GIDI_initialize (std::string const &a_dataPath)
std::string	G4GIDI_Misc_Z_toSymbol (int a_Z)
std::string	G4GIDI_Misc_Z_A_m_ToName (int a_Z, int a_A, int a_M)

Variables
PoPI::Database	G4GIDI_pops

Macro Definition Documentation

channelID

#define channelID   std::string

Definition at line 36 of file G4GIDI.hh.

Referenced by G4GIDI_target::getChannelsID().

Function Documentation

G4GIDI_GitHash()

std::string G4GIDI_GitHash

(

)

Returns the git repo hash for the G4GIDI repo for this version..

Returns

A std::string.

Definition at line 82 of file G4GIDI_misc.cc.

                            {
 
    return G4GIDI_GIT;
}

G4GIDI_initialize()

void G4GIDI_initialize

(

std::string const &

a_dataPath

)

Initialize the G4GIDI stuff.

Definition at line 66 of file G4GIDI.cc.

                                                      {
 
    if( G4GIDI_pops_initialized ) return;
 
    G4GIDI_pops_initialized = true;
    G4GIDI_pops.addFile( a_dataPath + "/" + "pops.xml", false );
    G4GIDI_pops.addFile( a_dataPath + "/" + "metastables_alias.xml", false );
}

G4GIDI_Misc_Z_A_m_ToName()

std::string G4GIDI_Misc_Z_A_m_ToName	(	int	a_Z,
		int	a_A,
		int	a_M )

Returns the PoPs for a specified atomic number a_Z, mass number a_A and meta-stable index a_M.

Parameters

a_Z	[in] The Z of the chemical element.
a_A	[in] The A of the isotope.
a_M	[in] The meta-stable index of the nuclide.

Returns

The symbol as a std::string.

Definition at line 130 of file G4GIDI_misc.cc.

                                                                {
 
    std::string id( G4GIDI_Misc_Z_toSymbol( a_Z ) + std::to_string( a_A ) );
 
    if( a_M > 0 ) id += "_" + std::to_string( a_M );
 
    return( id );
}

Referenced by G4GIDI::dataFilename(), G4GIDI::freeTarget(), G4GIDI::getAlreadyReadTarget(), G4GIDI::getNamesOfAvailableLibraries(), G4GIDI::isThisDataAvailable(), and G4GIDI::readTarget().

G4GIDI_Misc_Z_toSymbol()

std::string G4GIDI_Misc_Z_toSymbol

(

int

a_Z

)

Returns the chemical elemental symbol for a specified atomic number a_Z.

Parameters

a_Z	[in] The Z of the chemical element.

Returns

The symbol as a std::string.

Definition at line 109 of file G4GIDI_misc.cc.

                                            {
 
    int Zm1 = a_Z - 1;
 
    if( ( Zm1 < 0 ) || ( Zm1 >= static_cast<int>( G4GIDI_chemicalElementSymbols.size( ) ) ) ) {
        throw LUPI::Exception( "G4GIDI_Misc_Z_toSymbol: invalid Z = " + std::to_string( a_Z ) + "." );
    }
 
    return( std::string( G4GIDI_chemicalElementSymbols[Zm1] ) );
}

Referenced by G4GIDI_Misc_Z_A_m_ToName().

G4GIDI_version()

std::string G4GIDI_version

(

)

Returns the version string for the version of G4GIDI.

Returns

A std::string.

Definition at line 36 of file G4GIDI_misc.cc.

                            {
 
    std::string versionString( G4GIDI_VERSION );
 
    return versionString;
}

G4GIDI_versionMajor()

int G4GIDI_versionMajor

(

)

Returns the major version number for the version of G4GIDI.

Returns

An int.

Definition at line 49 of file G4GIDI_misc.cc.

                           {
 
    return G4GIDI_MAJOR;
}

G4GIDI_versionMinor()

int G4GIDI_versionMinor

(

)

Returns the minor version number for the version of G4GIDI.

Returns

An int.

Definition at line 60 of file G4GIDI_misc.cc.

                           {
 
    return G4GIDI_MINOR;
}

G4GIDI_versionPatchLevel()

int G4GIDI_versionPatchLevel

(

)

Returns the patch level number for the version of G4GIDI.

Returns

An int.

Definition at line 71 of file G4GIDI_misc.cc.

                                {
 
    return G4GIDI_PATCHLEVEL;
}

Variable Documentation

G4GIDI_pops

PoPI::Database G4GIDI_pops

extern

Definition at line 29 of file G4GIDI.cc.

Referenced by G4GIDI::addDataDirectory(), G4GIDI_initialize(), and G4GIDI::readTarget().