Geant4-11
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes | Friends
G4BaseRNtupleManager Class Referenceabstract

#include <G4BaseRNtupleManager.hh>

Inheritance diagram for G4BaseRNtupleManager:
G4VRNtupleManager G4BaseAnalysisManager G4TRNtupleManager< tools::rcsv::ntuple > G4TRNtupleManager< tools::hdf5::ntuple > G4TRNtupleManager< tools::rroot::ntuple > G4TRNtupleManager< tools::aida::ntuple > G4TRNtupleManager< NT > G4CsvRNtupleManager G4Hdf5RNtupleManager G4RootRNtupleManager G4XmlRNtupleManager

Public Member Functions

 G4BaseRNtupleManager ()=delete
 
 G4BaseRNtupleManager (const G4AnalysisManagerState &state)
 
 G4BaseRNtupleManager (const G4BaseRNtupleManager &rhs)=delete
 
G4int GetFirstId () const
 
G4BaseRNtupleManageroperator= (const G4BaseRNtupleManager &rhs)=delete
 
G4bool SetFirstId (G4int firstId)
 
void SetLockFirstId (G4bool lockFirstId)
 
virtual ~G4BaseRNtupleManager ()=default
 

Protected Member Functions

virtual G4int GetNofNtuples () const =0
 
virtual G4bool GetNtupleRow () final
 
virtual G4bool GetNtupleRow (G4int ntupleId)=0
 
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
 
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)=0
 
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)=0
 
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)=0
 
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)=0
 
virtual G4bool SetNtupleSColumn (G4int ntupleId, const G4String &columnName, std::vector< std::string > &vector)=0
 

Protected Attributes

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

Private Member Functions

G4int GetCurrentNtupleId () const
 

Static Private Attributes

static constexpr std::string_view fkClass { "G4BaseAnalysisManager" }
 

Friends

class G4VAnalysisReader
 

Detailed Description

Definition at line 40 of file G4BaseRNtupleManager.hh.

Constructor & Destructor Documentation

◆ G4BaseRNtupleManager() [1/3]

G4BaseRNtupleManager::G4BaseRNtupleManager ( const G4AnalysisManagerState state)
explicit

Definition at line 32 of file G4BaseRNtupleManager.cc.

33 : G4VRNtupleManager(state)
34{}
G4VRNtupleManager()=delete

◆ ~G4BaseRNtupleManager()

virtual G4BaseRNtupleManager::~G4BaseRNtupleManager ( )
virtualdefault

◆ G4BaseRNtupleManager() [2/3]

G4BaseRNtupleManager::G4BaseRNtupleManager ( )
delete

◆ G4BaseRNtupleManager() [3/3]

G4BaseRNtupleManager::G4BaseRNtupleManager ( const G4BaseRNtupleManager rhs)
delete

Member Function Documentation

◆ GetCurrentNtupleId()

G4int G4BaseRNtupleManager::GetCurrentNtupleId ( ) const
private

◆ GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const
inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

94 {
95 return fFirstId;
96}

References G4BaseAnalysisManager::fFirstId.

◆ GetNofNtuples()

virtual G4int G4BaseRNtupleManager::GetNofNtuples ( ) const
protectedpure virtual

◆ GetNtupleRow() [1/2]

G4bool G4BaseRNtupleManager::GetNtupleRow ( )
finalprotectedvirtual

◆ GetNtupleRow() [2/2]

virtual G4bool G4BaseRNtupleManager::GetNtupleRow ( G4int  ntupleId)
protectedpure virtual

◆ 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

◆ operator=()

G4BaseRNtupleManager & G4BaseRNtupleManager::operator= ( const G4BaseRNtupleManager rhs)
delete

◆ ReadNtupleImpl()

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

◆ 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().

◆ SetNtupleDColumn() [1/4]

G4bool G4BaseRNtupleManager::SetNtupleDColumn ( const G4String columnName,
G4double value 
)
finalprotectedvirtual

◆ SetNtupleDColumn() [2/4]

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

◆ SetNtupleDColumn() [3/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
G4double value 
)
protectedpure virtual

◆ SetNtupleDColumn() [4/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleDColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4double > &  vector 
)
protectedpure virtual

◆ SetNtupleFColumn() [1/4]

G4bool G4BaseRNtupleManager::SetNtupleFColumn ( const G4String columnName,
G4float value 
)
finalprotectedvirtual

◆ SetNtupleFColumn() [2/4]

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

◆ SetNtupleFColumn() [3/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
G4float value 
)
protectedpure virtual

◆ SetNtupleFColumn() [4/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleFColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4float > &  vector 
)
protectedpure virtual

◆ SetNtupleIColumn() [1/4]

G4bool G4BaseRNtupleManager::SetNtupleIColumn ( const G4String columnName,
G4int value 
)
finalprotectedvirtual

◆ SetNtupleIColumn() [2/4]

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

◆ SetNtupleIColumn() [3/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
G4int value 
)
protectedpure virtual

◆ SetNtupleIColumn() [4/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleIColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< G4int > &  vector 
)
protectedpure virtual

◆ SetNtupleSColumn() [1/4]

G4bool G4BaseRNtupleManager::SetNtupleSColumn ( const G4String columnName,
G4String value 
)
finalprotectedvirtual

◆ SetNtupleSColumn() [2/4]

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

◆ SetNtupleSColumn() [3/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
G4String value 
)
protectedpure virtual

◆ SetNtupleSColumn() [4/4]

virtual G4bool G4BaseRNtupleManager::SetNtupleSColumn ( G4int  ntupleId,
const G4String columnName,
std::vector< std::string > &  vector 
)
protectedpure virtual

Friends And Related Function Documentation

◆ G4VAnalysisReader

friend class G4VAnalysisReader
friend

Definition at line 44 of file G4BaseRNtupleManager.hh.

Field Documentation

◆ fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }
protectedinherited

◆ fkClass

constexpr std::string_view G4BaseAnalysisManager::fkClass { "G4BaseAnalysisManager" }
staticconstexprprivateinherited

Definition at line 75 of file G4BaseAnalysisManager.hh.

Referenced by G4BaseAnalysisManager::SetFirstId().

◆ fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }
protectedinherited

◆ fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState
protectedinherited

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