Geant4-11
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
G4TRNtupleManager< NT > Class Template Referenceabstract

#include <G4TRNtupleManager.hh>

Inheritance diagram for G4TRNtupleManager< NT >:
G4BaseRNtupleManager G4VRNtupleManager G4BaseAnalysisManager

Public Member Functions

G4int GetFirstId () const
 
G4bool SetFirstId (G4int firstId)
 
void SetLockFirstId (G4bool lockFirstId)
 

Protected Member Functions

 G4TRNtupleManager ()=delete
 
 G4TRNtupleManager (const G4AnalysisManagerState &state)
 
virtual G4int GetNofNtuples () const final
 
NT * GetNtuple () const
 
NT * GetNtuple (G4int ntupleId) const
 
G4TRNtupleDescription< NT > * GetNtupleDescriptionInFunction (G4int id, std::string_view function, G4bool warn=true) const
 
virtual G4bool GetNtupleRow () final
 
virtual G4bool GetNtupleRow (G4int ntupleId) final
 
virtual G4bool GetNtupleRow (G4int ntupleId)=0
 
G4bool IsEmpty () const
 
G4bool IsVerbose (G4int verboseLevel) const
 
void Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
 
virtual G4int ReadNtupleImpl (const G4String &ntupleName, const G4String &fileName, const G4String &dirName, G4bool isUserFileName)=0
 
G4bool Reset ()
 
G4int SetNtuple (G4TRNtupleDescription< NT > *rntupleDescription)
 
virtual G4bool SetNtupleDColumn (const G4String &columnName, G4double &value) final
 
virtual G4bool SetNtupleDColumn (const G4String &columnName, std::vector< G4double > &vector) final
 
virtual G4bool SetNtupleDColumn (G4int ntupleId, const G4String &columnName, G4double &value) final
 
virtual G4bool SetNtupleDColumn (G4int ntupleId, const G4String &columnName, G4double &value)=0
 
virtual G4bool SetNtupleDColumn (G4int ntupleId, const G4String &columnName, std::vector< G4double > &vector) override
 
virtual G4bool SetNtupleDColumn (G4int ntupleId, const G4String &columnName, std::vector< G4double > &vector)=0
 
virtual G4bool SetNtupleFColumn (const G4String &columnName, G4float &value) final
 
virtual G4bool SetNtupleFColumn (const G4String &columnName, std::vector< G4float > &vector) final
 
virtual G4bool SetNtupleFColumn (G4int ntupleId, const G4String &columnName, G4float &value) final
 
virtual G4bool SetNtupleFColumn (G4int ntupleId, const G4String &columnName, G4float &value)=0
 
virtual G4bool SetNtupleFColumn (G4int ntupleId, const G4String &columnName, std::vector< G4float > &vector) override
 
virtual G4bool SetNtupleFColumn (G4int ntupleId, const G4String &columnName, std::vector< G4float > &vector)=0
 
virtual G4bool SetNtupleIColumn (const G4String &columnName, G4int &value) final
 
virtual G4bool SetNtupleIColumn (const G4String &columnName, std::vector< G4int > &vector) final
 
virtual G4bool SetNtupleIColumn (G4int ntupleId, const G4String &columnName, G4int &value) final
 
virtual G4bool SetNtupleIColumn (G4int ntupleId, const G4String &columnName, G4int &value)=0
 
virtual G4bool SetNtupleIColumn (G4int ntupleId, const G4String &columnName, std::vector< G4int > &vector) override
 
virtual G4bool SetNtupleIColumn (G4int ntupleId, const G4String &columnName, std::vector< G4int > &vector)=0
 
virtual G4bool SetNtupleSColumn (const G4String &columnName, G4String &value) final
 
virtual G4bool SetNtupleSColumn (const G4String &columnName, std::vector< std::string > &vector) final
 
virtual G4bool SetNtupleSColumn (G4int ntupleId, const G4String &columnName, G4String &value) final
 
virtual G4bool SetNtupleSColumn (G4int ntupleId, const G4String &columnName, G4String &value)=0
 
virtual G4bool SetNtupleSColumn (G4int ntupleId, const G4String &columnName, std::vector< std::string > &vector) override
 
virtual G4bool SetNtupleSColumn (G4int ntupleId, const G4String &columnName, std::vector< std::string > &vector)=0
 
virtual ~G4TRNtupleManager ()
 

Protected Attributes

G4int fFirstId { 0 }
 
G4bool fLockFirstId { false }
 
const G4AnalysisManagerStatefState
 

Private Member Functions

G4int GetCurrentNtupleId () const
 
virtual G4bool GetTNtupleRow (G4TRNtupleDescription< NT > *rntupleDescription)=0
 
template<typename T >
G4bool SetNtupleTColumn (G4int ntupleId, const G4String &name, std::vector< T > &vector)
 
template<typename T >
G4bool SetNtupleTColumn (G4int ntupleId, const G4String &name, T &value)
 

Private Attributes

std::vector< G4TRNtupleDescription< NT > * > fNtupleDescriptionVector
 

Static Private Attributes

static constexpr std::string_view fkClass { "G4TRNtupleManager<NT>" }
 

Detailed Description

template<typename NT>
class G4TRNtupleManager< NT >

Definition at line 42 of file G4TRNtupleManager.hh.

Constructor & Destructor Documentation

◆ G4TRNtupleManager() [1/2]

template<typename NT >
G4TRNtupleManager< NT >::G4TRNtupleManager ( const G4AnalysisManagerState state)
explicitprotected

◆ G4TRNtupleManager() [2/2]

template<typename NT >
G4TRNtupleManager< NT >::G4TRNtupleManager ( )
protecteddelete

◆ ~G4TRNtupleManager()

template<typename NT >
virtual G4TRNtupleManager< NT >::~G4TRNtupleManager ( )
protectedvirtual

Member Function Documentation

◆ GetCurrentNtupleId()

G4int G4BaseRNtupleManager::GetCurrentNtupleId ( ) const
privateinherited

◆ GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const
inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

94 {
95 return fFirstId;
96}

References G4BaseAnalysisManager::fFirstId.

◆ GetNofNtuples()

template<typename NT >
virtual G4int G4TRNtupleManager< NT >::GetNofNtuples ( ) const
finalprotectedvirtual

Implements G4BaseRNtupleManager.

◆ GetNtuple() [1/2]

template<typename NT >
NT * G4TRNtupleManager< NT >::GetNtuple ( ) const
protected

◆ GetNtuple() [2/2]

template<typename NT >
NT * G4TRNtupleManager< NT >::GetNtuple ( G4int  ntupleId) const
protected

◆ GetNtupleDescriptionInFunction()

template<typename NT >
G4TRNtupleDescription< NT > * G4TRNtupleManager< NT >::GetNtupleDescriptionInFunction ( G4int  id,
std::string_view  function,
G4bool  warn = true 
) const
protected

◆ GetNtupleRow() [1/3]

template<typename NT >
G4bool G4BaseRNtupleManager::GetNtupleRow ( )
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 94 of file G4BaseRNtupleManager.cc.

102{
103 return GetNtupleRow(fFirstId);
104}
virtual G4bool GetNtupleRow() final

References G4BaseRNtupleManager::GetCurrentNtupleId(), and G4BaseRNtupleManager::SetNtupleSColumn().

◆ GetNtupleRow() [2/3]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::GetNtupleRow ( G4int  ntupleId)
finalprotectedvirtual

Implements G4BaseRNtupleManager.

◆ GetNtupleRow() [3/3]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::GetNtupleRow ( G4int  ntupleId)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ GetTNtupleRow()

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::GetTNtupleRow ( G4TRNtupleDescription< NT > *  rntupleDescription)
privatepure virtual

◆ IsEmpty()

template<typename NT >
G4bool G4TRNtupleManager< NT >::IsEmpty ( ) const
protected

◆ IsVerbose()

G4bool G4BaseAnalysisManager::IsVerbose ( G4int  verboseLevel) const
inlineprotectedinherited

Definition at line 80 of file G4BaseAnalysisManager.hh.

81{ return fState.IsVerbose(verboseLevel); }
G4bool IsVerbose(G4int verboseLevel) const
const G4AnalysisManagerState & fState

References G4BaseAnalysisManager::fState, and G4AnalysisManagerState::IsVerbose().

Referenced by G4RootPNtupleManager::AddNtupleRow(), and G4RootPNtupleManager::Merge().

◆ Message()

void G4BaseAnalysisManager::Message ( G4int  level,
const G4String action,
const G4String objectType,
const G4String objectName = "",
G4bool  success = true 
) const
inlineprotectedinherited

◆ ReadNtupleImpl()

virtual G4int G4VRNtupleManager::ReadNtupleImpl ( const G4String ntupleName,
const G4String fileName,
const G4String dirName,
G4bool  isUserFileName 
)
protectedpure virtualinherited

◆ Reset()

template<typename NT >
G4bool G4TRNtupleManager< NT >::Reset ( )
protected

◆ SetFirstId()

G4bool G4BaseAnalysisManager::SetFirstId ( G4int  firstId)
inherited

Definition at line 46 of file G4BaseAnalysisManager.cc.

47{
48 if ( fLockFirstId ) {
49 Warn("Cannot set FirstId as its value was already used.",
50 fkClass, "SetFirstId");
51
52 return false;
53 }
54
55 fFirstId = firstId;
56 return true;
57}
static constexpr std::string_view fkClass
void Warn(const G4String &message, const std::string_view inClass, const std::string_view inFunction)

References G4BaseAnalysisManager::fFirstId, G4BaseAnalysisManager::fkClass, G4BaseAnalysisManager::fLockFirstId, and G4Analysis::Warn().

◆ SetLockFirstId()

void G4BaseAnalysisManager::SetLockFirstId ( G4bool  lockFirstId)
inlineinherited

Definition at line 90 of file G4BaseAnalysisManager.hh.

90 {
91 fLockFirstId = lockFirstId;
92}

References G4BaseAnalysisManager::fLockFirstId.

Referenced by G4HnManager::ClearData().

◆ SetNtuple()

template<typename NT >
G4int G4TRNtupleManager< NT >::SetNtuple ( G4TRNtupleDescription< NT > *  rntupleDescription)
protected

◆ SetNtupleDColumn() [1/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleDColumn ( const G4String columnName,
G4double value 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 62 of file G4BaseRNtupleManager.cc.

61{
62 return SetNtupleDColumn(GetCurrentNtupleId(), columnName, value);
63}
G4int GetCurrentNtupleId() const
virtual G4bool SetNtupleDColumn(G4int ntupleId, const G4String &columnName, G4double &value) final

◆ SetNtupleDColumn() [2/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleDColumn ( const G4String columnName,
std::vector< G4double > &  vector 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 81 of file G4BaseRNtupleManager.cc.

89{
90 return SetNtupleDColumn(GetCurrentNtupleId(), columnName, vector);
91}

◆ SetNtupleDColumn() [3/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
G4double value 
)
finalprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager.

◆ SetNtupleDColumn() [4/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
G4double value 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleDColumn() [5/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4double > &  vector 
)
overrideprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager, and G4XmlRNtupleManager.

◆ SetNtupleDColumn() [6/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4double > &  vector 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleFColumn() [1/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleFColumn ( const G4String columnName,
G4float value 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 60 of file G4BaseRNtupleManager.cc.

54{
55 return SetNtupleFColumn(GetCurrentNtupleId(), columnName, value);
56}
virtual G4bool SetNtupleFColumn(G4int ntupleId, const G4String &columnName, G4float &value) final

◆ SetNtupleFColumn() [2/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleFColumn ( const G4String columnName,
std::vector< G4float > &  vector 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 79 of file G4BaseRNtupleManager.cc.

82{
83 return SetNtupleFColumn(GetCurrentNtupleId(), columnName, vector);
84}

◆ SetNtupleFColumn() [3/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
G4float value 
)
finalprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager.

◆ SetNtupleFColumn() [4/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
G4float value 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleFColumn() [5/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4float > &  vector 
)
overrideprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager, and G4XmlRNtupleManager.

◆ SetNtupleFColumn() [6/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4float > &  vector 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleIColumn() [1/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleIColumn ( const G4String columnName,
G4int value 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 58 of file G4BaseRNtupleManager.cc.

48{
49 return SetNtupleIColumn(GetCurrentNtupleId(), columnName, value);
50}
virtual G4bool SetNtupleIColumn(G4int ntupleId, const G4String &columnName, G4int &value) final

◆ SetNtupleIColumn() [2/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleIColumn ( const G4String columnName,
std::vector< G4int > &  vector 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 77 of file G4BaseRNtupleManager.cc.

75{
76 return SetNtupleIColumn(GetCurrentNtupleId(), columnName, vector);
77}

◆ SetNtupleIColumn() [3/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
G4int value 
)
finalprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager.

◆ SetNtupleIColumn() [4/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
G4int value 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleIColumn() [5/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4int > &  vector 
)
overrideprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager, and G4XmlRNtupleManager.

◆ SetNtupleIColumn() [6/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4int > &  vector 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleSColumn() [1/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleSColumn ( const G4String columnName,
G4String value 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 64 of file G4BaseRNtupleManager.cc.

68{
69 return SetNtupleSColumn(GetCurrentNtupleId(), columnName, value);
70}
virtual G4bool SetNtupleSColumn(G4int ntupleId, const G4String &columnName, G4String &value) final

◆ SetNtupleSColumn() [2/6]

template<typename NT >
G4bool G4BaseRNtupleManager::SetNtupleSColumn ( const G4String columnName,
std::vector< std::string > &  vector 
)
finalprotectedvirtual

Reimplemented from G4BaseRNtupleManager.

Definition at line 83 of file G4BaseRNtupleManager.cc.

96{
97 return SetNtupleSColumn(GetCurrentNtupleId(), columnName, vector);
98}

◆ SetNtupleSColumn() [3/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
G4String value 
)
finalprotectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleSColumn() [4/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
G4String value 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleSColumn() [5/6]

template<typename NT >
virtual G4bool G4TRNtupleManager< NT >::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< std::string > &  vector 
)
overrideprotectedvirtual

Implements G4BaseRNtupleManager.

Reimplemented in G4XmlRNtupleManager.

◆ SetNtupleSColumn() [6/6]

template<typename NT >
virtual G4bool G4BaseRNtupleManager::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< std::string > &  vector 
)
protectedvirtual

Implements G4BaseRNtupleManager.

◆ SetNtupleTColumn() [1/2]

template<typename NT >
template<typename T >
G4bool G4TRNtupleManager< NT >::SetNtupleTColumn ( G4int  ntupleId,
const G4String name,
std::vector< T > &  vector 
)
private

◆ SetNtupleTColumn() [2/2]

template<typename NT >
template<typename T >
G4bool G4TRNtupleManager< NT >::SetNtupleTColumn ( G4int  ntupleId,
const G4String name,
T &  value 
)
private

Field Documentation

◆ fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }
protectedinherited

◆ fkClass

template<typename NT >
constexpr std::string_view G4TRNtupleManager< NT >::fkClass { "G4TRNtupleManager<NT>" }
staticconstexprprivate

Definition at line 115 of file G4TRNtupleManager.hh.

◆ fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }
protectedinherited

◆ fNtupleDescriptionVector

template<typename NT >
std::vector<G4TRNtupleDescription<NT>*> G4TRNtupleManager< NT >::fNtupleDescriptionVector
private

Definition at line 118 of file G4TRNtupleManager.hh.

◆ fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState
protectedinherited

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