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

#include <G4VNtupleManager.hh>

Inheritance diagram for G4VNtupleManager:
G4BaseAnalysisManager G4BaseNtupleManager G4TNtupleManager< tools::wcsv::ntuple, std::ofstream > G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File > G4TNtupleManager< tools::wroot::ntuple, G4RootFile > G4TNtupleManager< tools::waxml::ntuple, std::ofstream > G4RootPNtupleManager G4TNtupleManager< NT, FT > G4CsvNtupleManager G4Hdf5NtupleManager G4RootNtupleManager G4XmlNtupleManager

Public Member Functions

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

Protected Member Functions

virtual G4bool AddNtupleRow ()=0
 
virtual G4bool AddNtupleRow (G4int ntupleId)=0
 
virtual void Clear ()=0
 
virtual G4int CreateNtuple (G4NtupleBooking *booking)=0
 
virtual G4bool FillNtupleDColumn (G4int id, G4double value)=0
 
virtual G4bool FillNtupleDColumn (G4int ntupleId, G4int columnId, G4double value)=0
 
virtual G4bool FillNtupleFColumn (G4int id, G4float value)=0
 
virtual G4bool FillNtupleFColumn (G4int ntupleId, G4int columnId, G4float value)=0
 
virtual G4bool FillNtupleIColumn (G4int id, G4int value)=0
 
virtual G4bool FillNtupleIColumn (G4int ntupleId, G4int columnId, G4int value)=0
 
virtual G4bool FillNtupleSColumn (G4int id, const G4String &value)=0
 
virtual G4bool FillNtupleSColumn (G4int ntupleId, G4int columnId, const G4String &value)=0
 
virtual G4bool GetActivation (G4int id) const =0
 
virtual G4int GetNofNtuples () const =0
 
G4bool IsVerbose (G4int verboseLevel) const
 
void Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
 
virtual void SetActivation (G4bool activation)=0
 
virtual void SetActivation (G4int id, G4bool activation)=0
 
virtual G4bool SetFirstNtupleColumnId (G4int firstId)=0
 

Protected Attributes

G4int fFirstId { 0 }
 
G4bool fLockFirstId { false }
 
const G4AnalysisManagerState & fState
 

Static Private Attributes

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

Friends

class G4VAnalysisManager
 

Detailed Description

Definition at line 42 of file G4VNtupleManager.hh.

Constructor & Destructor Documentation

◆ G4VNtupleManager() [1/3]

G4VNtupleManager::G4VNtupleManager ( const G4AnalysisManagerState &  state)
inlineexplicit

Definition at line 49 of file G4VNtupleManager.hh.

50 : G4BaseAnalysisManager(state) {}
G4BaseAnalysisManager::G4BaseAnalysisManager
G4BaseAnalysisManager()=delete

◆ G4VNtupleManager() [2/3]

G4VNtupleManager::G4VNtupleManager ( )
delete

◆ ~G4VNtupleManager()

virtual G4VNtupleManager::~G4VNtupleManager ( )
virtualdefault

◆ G4VNtupleManager() [3/3]

G4VNtupleManager::G4VNtupleManager ( const G4VNtupleManager &  rhs)
delete

Member Function Documentation

◆ AddNtupleRow() [1/2]

virtual G4bool G4VNtupleManager::AddNtupleRow ( )
protectedpure virtual

Implemented in G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ AddNtupleRow() [2/2]

virtual G4bool G4VNtupleManager::AddNtupleRow ( G4int  ntupleId)
protectedpure virtual

Implemented in G4RootPNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ Clear()

virtual void G4VNtupleManager::Clear ( )
protectedpure virtual

Implemented in G4RootNtupleManager, G4RootPNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, and G4TNtupleManager< tools::waxml::ntuple, std::ofstream >.

◆ CreateNtuple()

virtual G4int G4VNtupleManager::CreateNtuple ( G4NtupleBooking *  booking)
protectedpure virtual

Implemented in G4RootPNtupleManager, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, and G4TNtupleManager< tools::waxml::ntuple, std::ofstream >.

◆ FillNtupleDColumn() [1/2]

virtual G4bool G4VNtupleManager::FillNtupleDColumn ( G4int  id,
G4double  value 
)
protectedpure virtual

Implemented in G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleDColumn() [2/2]

virtual G4bool G4VNtupleManager::FillNtupleDColumn ( G4int  ntupleId,
G4int  columnId,
G4double  value 
)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, G4RootPNtupleManager, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleFColumn() [1/2]

virtual G4bool G4VNtupleManager::FillNtupleFColumn ( G4int  id,
G4float  value 
)
protectedpure virtual

Implemented in G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleFColumn() [2/2]

virtual G4bool G4VNtupleManager::FillNtupleFColumn ( G4int  ntupleId,
G4int  columnId,
G4float  value 
)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, G4RootPNtupleManager, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleIColumn() [1/2]

virtual G4bool G4VNtupleManager::FillNtupleIColumn ( G4int  id,
G4int  value 
)
protectedpure virtual

Implemented in G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleIColumn() [2/2]

virtual G4bool G4VNtupleManager::FillNtupleIColumn ( G4int  ntupleId,
G4int  columnId,
G4int  value 
)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, G4RootPNtupleManager, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleSColumn() [1/2]

virtual G4bool G4VNtupleManager::FillNtupleSColumn ( G4int  id,
const G4String &  value 
)
protectedpure virtual

Implemented in G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ FillNtupleSColumn() [2/2]

virtual G4bool G4VNtupleManager::FillNtupleSColumn ( G4int  ntupleId,
G4int  columnId,
const G4String &  value 
)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, G4RootPNtupleManager, G4BaseNtupleManager, G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ GetActivation()

virtual G4bool G4VNtupleManager::GetActivation ( G4int  id) const
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ 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 G4VNtupleManager::GetNofNtuples ( ) const
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ IsVerbose()

G4bool G4BaseAnalysisManager::IsVerbose ( G4int  verboseLevel) const
inlineprotectedinherited

Definition at line 80 of file G4BaseAnalysisManager.hh.

81{ return fState.IsVerbose(verboseLevel); }
G4AnalysisManagerState::IsVerbose
G4bool IsVerbose(G4int verboseLevel) const
Definition: G4AnalysisManagerState.hh:107
G4BaseAnalysisManager::fState
const G4AnalysisManagerState & fState
Definition: G4BaseAnalysisManager.hh:69

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

Definition at line 83 of file G4BaseAnalysisManager.hh.

86{
87 fState.Message(level, action, objectType, objectName, success);
88}
G4AnalysisManagerState::Message
void Message(G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
Definition: G4AnalysisManagerState.cc:64
geant4_check_module_cycles.action
action
Definition: geant4_check_module_cycles.py:49

References geant4_check_module_cycles::action, G4BaseAnalysisManager::fState, and G4AnalysisManagerState::Message().

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootPNtupleManager::Clear(), G4NtupleBookingManager::ClearData(), G4RootMainNtupleManager::ClearData(), G4NtupleBookingManager::CreateNtuple(), G4RootMainNtupleManager::CreateNtuple(), G4RootPNtupleManager::CreateNtupleFromMain(), G4RootPNtupleManager::Merge(), G4CsvRNtupleManager::ReadNtupleImpl(), G4Hdf5RNtupleManager::ReadNtupleImpl(), G4RootRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::SetNtupleDColumn(), G4XmlRNtupleManager::SetNtupleFColumn(), G4XmlRNtupleManager::SetNtupleIColumn(), and G4XmlRNtupleManager::SetNtupleSColumn().

◆ operator=()

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

◆ SetActivation() [1/2]

virtual void G4VNtupleManager::SetActivation ( G4bool  activation)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ SetActivation() [2/2]

virtual void G4VNtupleManager::SetActivation ( G4int  id,
G4bool  activation 
)
protectedpure virtual

Implemented in G4TNtupleManager< NT, FT >, G4TNtupleManager< tools::wcsv::ntuple, std::ofstream >, G4TNtupleManager< tools::hdf5::ntuple, G4Hdf5File >, G4TNtupleManager< tools::wroot::ntuple, G4RootFile >, G4TNtupleManager< tools::waxml::ntuple, std::ofstream >, and G4RootPNtupleManager.

◆ 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}
G4BaseAnalysisManager::fkClass
static constexpr std::string_view fkClass
Definition: G4BaseAnalysisManager.hh:75
G4Analysis::Warn
void Warn(const G4String &message, const std::string_view inClass, const std::string_view inFunction)
Definition: G4AnalysisUtilities.cc:66

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

◆ SetFirstNtupleColumnId()

virtual G4bool G4VNtupleManager::SetFirstNtupleColumnId ( G4int  firstId)
protectedpure virtual

Implemented in G4BaseNtupleManager.

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

Friends And Related Function Documentation

◆ G4VAnalysisManager

friend class G4VAnalysisManager
friend

Definition at line 46 of file G4VNtupleManager.hh.

Field Documentation

◆ fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }
protectedinherited

Definition at line 70 of file G4BaseAnalysisManager.hh.

Referenced by G4BaseNtupleManager::AddNtupleRow(), G4NtupleBookingManager::CreateNtuple(), G4BaseNtupleManager::FillNtupleDColumn(), G4BaseNtupleManager::FillNtupleFColumn(), G4BaseNtupleManager::FillNtupleIColumn(), G4BaseRNtupleManager::GetCurrentNtupleId(), G4BaseAnalysisManager::GetFirstId(), G4HnManager::GetHnInformation(), G4RootPNtupleManager::GetMainNtupleInFunction(), G4NtupleBookingManager::GetNtupleBookingInFunction(), G4RootPNtupleManager::GetNtupleDescriptionInFunction(), G4BaseRNtupleManager::GetNtupleRow(), and G4BaseAnalysisManager::SetFirstId().

◆ 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

Definition at line 71 of file G4BaseAnalysisManager.hh.

Referenced by G4NtupleBookingManager::CreateNtuple(), G4BaseAnalysisManager::SetFirstId(), and G4BaseAnalysisManager::SetLockFirstId().

◆ fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState
protectedinherited

Definition at line 69 of file G4BaseAnalysisManager.hh.

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootNtupleManager::G4RootNtupleManager(), G4BaseAnalysisManager::IsVerbose(), and G4BaseAnalysisManager::Message().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.3