Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
GIDI::TargetInfo::Nuclide Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::TargetInfo::Nuclide:

Public Member Functions

 Nuclide (HAPI::Node const &a_node)
 ~Nuclide ()
std::string const & pid () const
double atomFraction () const
GUPI::AncestryfindInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const * findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
void toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GUPI::Entry
 Entry (std::string const &a_moniker, std::string const &a_keyName, std::string const &a_keyValue)
 Entry (HAPI::Node const &a_node, std::string const &a_keyName)
 ~Entry ()
std::string const & keyName () const
std::string const & keyValue () const
AncestryfindInAncestry3 (LUPI_maybeUnused std::string const &a_item)
Ancestry const * findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
LUPI_HOST void serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
 Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual ~Ancestry ()
Ancestryoperator= (Ancestry const &a_ancestry)
std::string const & moniker () const
void setMoniker (std::string const &a_moniker)
Ancestryancestor ()
Ancestry const * ancestor () const
void setAncestor (Ancestry *a_ancestor)
std::string attribute () const
Ancestryroot ()
Ancestry const * root () const
bool isChild (Ancestry *a_instance)
bool isParent (Ancestry *a_parent)
bool isRoot () const
AncestryfindInAncestry (std::string const &a_href)
Ancestry const * findInAncestry (std::string const &a_href) const
virtual AncestryfindInAncestry3 (std::string const &a_item)=0
virtual Ancestry const * findInAncestry3 (std::string const &a_item) const =0
std::string toXLink () const
void printXML () const

Additional Inherited Members

Static Public Member Functions inherited from GUPI::Ancestry
static std::string buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

The class that stores a chemicalElement node.

Definition at line 2927 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Nuclide()

GIDI::TargetInfo::Nuclide::Nuclide ( HAPI::Node const & a_node)

Definition at line 31 of file GIDI_targetInfo.cc.

31 :
32 GUPI::Entry( a_node, GIDI_pidChars ),
33 m_atomFraction( a_node.attribute( GIDI_atomFractionChars ).as_double( ) ) {
34
35}
#define GIDI_atomFractionChars
Definition GIDI.hpp:470
#define GIDI_pidChars
Definition GIDI.hpp:454

◆ ~Nuclide()

GIDI::TargetInfo::Nuclide::~Nuclide ( )

Definition at line 40 of file GIDI_targetInfo.cc.

40 {
41
42}

Member Function Documentation

◆ atomFraction()

double GIDI::TargetInfo::Nuclide::atomFraction ( ) const
inline

Returns the value of the m_atomFraction member.

Definition at line 2937 of file GIDI.hpp.

Referenced by toXMLList().

◆ findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::TargetInfo::Nuclide::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item)
inline

Definition at line 2939 of file GIDI.hpp.

2939{ return( nullptr ); }

◆ findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::TargetInfo::Nuclide::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item) const
inline

Definition at line 2940 of file GIDI.hpp.

2940{ return( nullptr ); }

◆ pid()

std::string const & GIDI::TargetInfo::Nuclide::pid ( ) const
inline

Returns a const reference to the results of the call to the keyValue() method.

Definition at line 2936 of file GIDI.hpp.

Referenced by toXMLList().

◆ toXMLList()

void GIDI::TargetInfo::Nuclide::toXMLList ( GUPI::WriteInfo & a_writeInfo,
std::string const & a_indent = "" ) const
virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters
a_writeInfo[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent[in] The amount to indent this node.

Reimplemented from GUPI::Ancestry.

Definition at line 51 of file GIDI_targetInfo.cc.

51 {
52
53 std::string attributes;
54
55 attributes = a_writeInfo.addAttribute( GIDI_pidChars, pid( ) );
57 a_writeInfo.addNodeStarterEnder( a_indent, moniker( ), attributes );
58}
double atomFraction() const
Definition GIDI.hpp:2937
std::string const & pid() const
Definition GIDI.hpp:2936
std::string const & moniker() const
Definition GUPI.hpp:102
void addNodeStarterEnder(std::string const &indent, std::string const &a_moniker, std::string const &a_attributes="")
Definition GUPI.hpp:57
std::string addAttribute(std::string const &a_name, std::string const &a_value) const
Definition GUPI.hpp:60
std::string doubleToShortestString(double a_value, int a_significantDigits=15, int a_favorEFormBy=0)
Definition LUPI_misc.cc:349

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