Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
GUPI::Documentation Class Reference

#include <GUPI.hpp>

Inheritance diagram for GUPI::Documentation:

Public Member Functions

 Documentation (HAPI::Node const &a_node)
 ~Documentation ()
std::string const & doi () const
std::string const & publicationDate () const
std::string const & version () const
Text const & title () const
Text const & abstract () const
Text const & body () const
AncestryfindInAncestry3 (LUPI_maybeUnused std::string const &a_item)
Ancestry const * findInAncestry3 (LUPI_maybeUnused std::string const &a_item) 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
virtual LUPI_HOST void serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
virtual std::string xlinkItemKey () const
std::string toXLink () const
virtual void toXMLList (WriteInfo &a_writeInfo, std::string const &a_indent="") 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

Definition at line 210 of file GUPI.hpp.

Constructor & Destructor Documentation

◆ Documentation()

GUPI::Documentation::Documentation ( HAPI::Node const & a_node)

Definition at line 18 of file GUPI_documentation.cc.

18 :
19 Ancestry(a_node.name()),
20 m_doi(a_node.attribute_as_string(GUPI_doiChars)),
21 m_publicationDate(a_node.attribute_as_string(GUPI_publicationDateChars)),
22 m_version(a_node.attribute_as_string(GUPI_versionChars)),
23 m_title(a_node.child(GUPI_titleChars)),
24 m_abstract(a_node.child(GUPI_abstractChars)),
25 m_body(a_node.child(GUPI_bodyChars)) {
26
27 m_title.setAncestor(this);
28 m_abstract.setAncestor(this);
29 m_body.setAncestor(this);
30}
#define GUPI_publicationDateChars
Definition GUPI.hpp:33
#define GUPI_versionChars
Definition GUPI.hpp:34
#define GUPI_abstractChars
Definition GUPI.hpp:29
#define GUPI_doiChars
Definition GUPI.hpp:32
#define GUPI_bodyChars
Definition GUPI.hpp:30
#define GUPI_titleChars
Definition GUPI.hpp:28
Ancestry(std::string const &a_moniker, std::string const &a_attribute="")

◆ ~Documentation()

GUPI::Documentation::~Documentation ( )

Definition at line 35 of file GUPI_documentation.cc.

35 {
36
37}

Member Function Documentation

◆ abstract()

Text const & GUPI::Documentation::abstract ( ) const
inline

Definition at line 231 of file GUPI.hpp.

231{ return m_abstract; }

◆ body()

Text const & GUPI::Documentation::body ( ) const
inline

Definition at line 232 of file GUPI.hpp.

232{ return m_body; }

◆ doi()

std::string const & GUPI::Documentation::doi ( ) const
inline

Definition at line 226 of file GUPI.hpp.

226{ return m_doi; }

◆ findInAncestry3() [1/2]

Ancestry * GUPI::Documentation::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item)
inline

Definition at line 234 of file GUPI.hpp.

234{ return( nullptr ); }

◆ findInAncestry3() [2/2]

Ancestry const * GUPI::Documentation::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item) const
inline

Definition at line 235 of file GUPI.hpp.

235{ return( nullptr ); }

◆ publicationDate()

std::string const & GUPI::Documentation::publicationDate ( ) const
inline

Definition at line 227 of file GUPI.hpp.

227{ return m_publicationDate; }

◆ title()

Text const & GUPI::Documentation::title ( ) const
inline

Definition at line 230 of file GUPI.hpp.

230{ return m_title; }

◆ version()

std::string const & GUPI::Documentation::version ( ) const
inline

Definition at line 228 of file GUPI.hpp.

228{ return m_version; }

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