#include <G4RootMainNtupleManager.hh>

Inheritance diagram for G4RootMainNtupleManager:

Public Member Functions
	G4RootMainNtupleManager ()=delete

	G4RootMainNtupleManager (G4RootNtupleManager *ntupleBuilder, std::shared_ptr< G4NtupleBookingManager > bookingManager, G4bool rowWise, G4int fileNumber, const G4AnalysisManagerState &state)

G4int	GetFirstId () const

G4bool	SetFirstId (G4int firstId)

void	SetLockFirstId (G4bool lockFirstId)

virtual	~G4RootMainNtupleManager ()=default

Protected Member Functions
void	ClearData ()

void	CreateNtuple (RootNtupleDescription *ntupleDescription, G4bool warn=true)

unsigned int	GetBasketEntries () const

std::shared_ptr< G4RootFile >	GetNtupleFile (RootNtupleDescription *ntupleDescription) const

const std::vector< tools::wroot::ntuple * > &	GetNtupleVector ()

G4bool	IsVerbose (G4int verboseLevel) const

G4bool	Merge ()

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

G4bool	Reset ()

void	SetFileManager (std::shared_ptr< G4RootFileManager > fileManager)

void	SetRowWise (G4bool rowWise)

Protected Attributes
G4int	fFirstId { 0 }

G4bool	fLockFirstId { false }

const G4AnalysisManagerState &	fState

Private Attributes
std::shared_ptr< G4NtupleBookingManager >	fBookingManager { nullptr }

std::shared_ptr< G4RootFileManager >	fFileManager { nullptr }

G4int	fFileNumber

G4RootNtupleManager *	fNtupleBuilder { nullptr }

std::vector< RootNtupleDescription * >	fNtupleDescriptionVector

std::vector< tools::wroot::ntuple * >	fNtupleVector

G4bool	fRowWise

Static Private Attributes
static constexpr std::string_view	fkClass { "G4RootMainNtupleManager" }

Friends
class	G4RootNtupleManager

class	G4RootPNtupleManager

Detailed Description

Definition at line 57 of file G4RootMainNtupleManager.hh.

Constructor & Destructor Documentation

◆ G4RootMainNtupleManager() [1/2]

G4RootMainNtupleManager::G4RootMainNtupleManager	(	G4RootNtupleManager *	ntupleBuilder,
		std::shared_ptr< G4NtupleBookingManager >	bookingManager,
		G4bool	rowWise,
		G4int	fileNumber,
		const G4AnalysisManagerState &	state
	)

Definition at line 40 of file G4RootMainNtupleManager.cc.

 : G4BaseAnalysisManager(state),
   fNtupleBuilder(ntupleBuilder),
   fBookingManager(std::move(bookingManager)),
   fRowWise(rowWise),
   fFileNumber(fileNumber)
{}

◆ G4RootMainNtupleManager() [2/2]

G4RootMainNtupleManager::G4RootMainNtupleManager ( )

delete

◆ ~G4RootMainNtupleManager()

virtual G4RootMainNtupleManager::~G4RootMainNtupleManager ( )

virtualdefault

Member Function Documentation

◆ ClearData()

void G4RootMainNtupleManager::ClearData ( )

protected

Definition at line 122 of file G4RootMainNtupleManager.cc.

{
  // Reset function clears all data
  Reset();
 
  Message(G4Analysis::kVL2, "clear", "main ntuples");
}

References G4Analysis::kVL2, G4BaseAnalysisManager::Message(), and Reset().

◆ CreateNtuple()

void G4RootMainNtupleManager::CreateNtuple	(	RootNtupleDescription *	ntupleDescription,
		G4bool	warn = `true`
	)

protected

Definition at line 58 of file G4RootMainNtupleManager.cc.

{
// Create ntuple from booking if file was open
 
  // Get/Create main ntuple file
  auto ntupleFile = fFileManager->CreateNtupleFile(ntupleDescription, fFileNumber);
  if ( ! ntupleFile ) {
    if ( warn ) {
        Warn("Ntuple file must be defined first.\n"
             "Cannot create main ntuple.",
             fkClass, "CreateNtuple");
      }
    return;
  }
 
  // Get ntuple booking
  auto ntupleBooking = ntupleDescription->fNtupleBooking;
 
  Message(kVL4, "create", "main ntuple", ntupleBooking.name());
 
  // Create ntuple
  auto ntuple = new tools::wroot::ntuple(*std::get<2>(*ntupleFile), ntupleBooking, fRowWise);
         // ntuple object is deleted automatically when closing a file
  auto basketSize = fNtupleBuilder->GetBasketSize();
  ntuple->set_basket_size(basketSize);
 
  fNtupleVector.push_back(ntuple);
  fNtupleDescriptionVector.push_back(ntupleDescription);
 
  Message(kVL3, "create", "main ntuple", ntupleBooking.name());
}

References fFileManager, fFileNumber, fkClass, G4TNtupleDescription< NT, FT >::fNtupleBooking, fNtupleBuilder, fNtupleDescriptionVector, fNtupleVector, fRowWise, G4RootNtupleManager::GetBasketSize(), G4Analysis::kVL3, G4Analysis::kVL4, G4BaseAnalysisManager::Message(), and G4Analysis::Warn().

◆ GetBasketEntries()

unsigned int G4RootMainNtupleManager::GetBasketEntries ( ) const

inlineprotected

Definition at line 109 of file G4RootMainNtupleManager.hh.

110{ return fNtupleBuilder->GetBasketEntries(); }

G4RootNtupleManager::GetBasketEntries

unsigned int GetBasketEntries() const

Definition: G4RootNtupleManager.cc:199

References fNtupleBuilder, and G4RootNtupleManager::GetBasketEntries().

◆ GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References G4BaseAnalysisManager::fFirstId.

◆ GetNtupleFile()

std::shared_ptr< G4RootFile > G4RootMainNtupleManager::GetNtupleFile ( RootNtupleDescription * ntupleDescription ) const

protected

Definition at line 132 of file G4RootMainNtupleManager.cc.

{
  auto perThread = false;
  return fFileManager->GetNtupleFile(ntupleDescription, perThread, fFileNumber);
}

References fFileManager, and fFileNumber.

◆ GetNtupleVector()

const std::vector< tools::wroot::ntuple * > & G4RootMainNtupleManager::GetNtupleVector ( )

inlineprotected

Definition at line 84 of file G4RootMainNtupleManager.hh.

85 { return fNtupleVector; }

References fNtupleVector.

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

◆ Merge()

G4bool G4RootMainNtupleManager::Merge ( )

protected

Definition at line 92 of file G4RootMainNtupleManager.cc.

{
  std::size_t counter = 0;
 
  for ( auto ntuple : fNtupleVector ) {
    ntuple->merge_number_of_entries();
 
    // Notify ntuple description that file is not empty
    if ( ntuple->entries() ) {
      auto ntupleDescription = fNtupleDescriptionVector.at(counter);
      ntupleDescription->fHasFill = true;
    }
    ++counter;
  }
 
  return true;
}

References fNtupleDescriptionVector, and fNtupleVector.

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

{
  fState.Message(level, action, objectType, objectName, success);
}

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

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

◆ Reset()

G4bool G4RootMainNtupleManager::Reset ( )

protected

Definition at line 111 of file G4RootMainNtupleManager.cc.

{
  // ntuple object is deleted automatically when closing a file
 
  fNtupleVector.clear();
  fNtupleDescriptionVector.clear();
 
  return true;
}

References fNtupleDescriptionVector, and fNtupleVector.

Referenced by ClearData().

◆ SetFileManager()

void G4RootMainNtupleManager::SetFileManager ( std::shared_ptr< G4RootFileManager > fileManager )

inlineprotected

Definition at line 102 of file G4RootMainNtupleManager.hh.

104{ fFileManager = fileManager; }

References fFileManager.

◆ SetFirstId()

G4bool G4BaseAnalysisManager::SetFirstId ( G4int firstId )

inherited

Definition at line 46 of file G4BaseAnalysisManager.cc.

{
  if ( fLockFirstId ) {
    Warn("Cannot set FirstId as its value was already used.",
      fkClass, "SetFirstId");
 
    return false;
  }
 
  fFirstId = firstId;
  return true;
}

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.

                                                                    {
  fLockFirstId = lockFirstId;
}

References G4BaseAnalysisManager::fLockFirstId.

Referenced by G4HnManager::ClearData().

◆ SetRowWise()

void G4RootMainNtupleManager::SetRowWise ( G4bool rowWise )

inlineprotected

Definition at line 106 of file G4RootMainNtupleManager.hh.

107{ fRowWise = rowWise; }

References fRowWise.

Friends And Related Function Documentation

◆ G4RootNtupleManager

friend class G4RootNtupleManager

friend

Definition at line 60 of file G4RootMainNtupleManager.hh.

◆ G4RootPNtupleManager

friend class G4RootPNtupleManager

friend

Definition at line 59 of file G4RootMainNtupleManager.hh.

Field Documentation

◆ fBookingManager

std::shared_ptr<G4NtupleBookingManager> G4RootMainNtupleManager::fBookingManager { nullptr }

private

Definition at line 94 of file G4RootMainNtupleManager.hh.

◆ fFileManager

std::shared_ptr<G4RootFileManager> G4RootMainNtupleManager::fFileManager { nullptr }

private

Definition at line 95 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), GetNtupleFile(), and SetFileManager().

◆ fFileNumber

G4int G4RootMainNtupleManager::fFileNumber

private

Definition at line 97 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), and GetNtupleFile().

◆ 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 G4RootMainNtupleManager::fkClass { "G4RootMainNtupleManager" }

staticconstexprprivate

Definition at line 90 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple().

◆ fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protectedinherited

Definition at line 71 of file G4BaseAnalysisManager.hh.

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

◆ fNtupleBuilder

G4RootNtupleManager* G4RootMainNtupleManager::fNtupleBuilder { nullptr }

private

Definition at line 93 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), and GetBasketEntries().

◆ fNtupleDescriptionVector

std::vector<RootNtupleDescription*> G4RootMainNtupleManager::fNtupleDescriptionVector

private

Definition at line 99 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), Merge(), and Reset().

◆ fNtupleVector

std::vector<tools::wroot::ntuple*> G4RootMainNtupleManager::fNtupleVector

private

Definition at line 98 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), GetNtupleVector(), Merge(), and Reset().

◆ fRowWise

G4bool G4RootMainNtupleManager::fRowWise

private

Definition at line 96 of file G4RootMainNtupleManager.hh.

Referenced by CreateNtuple(), and SetRowWise().

◆ 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 files:

source/analysis/root/include/G4RootMainNtupleManager.hh
source/analysis/root/src/G4RootMainNtupleManager.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ G4RootMainNtupleManager() [1/2]

◆ G4RootMainNtupleManager() [2/2]

◆ ~G4RootMainNtupleManager()

Member Function Documentation

◆ ClearData()

◆ CreateNtuple()

◆ GetBasketEntries()

◆ GetFirstId()

◆ GetNtupleFile()

◆ GetNtupleVector()

◆ IsVerbose()

◆ Merge()

◆ Message()

◆ Reset()

◆ SetFileManager()

◆ SetFirstId()

◆ SetLockFirstId()

◆ SetRowWise()

Friends And Related Function Documentation

◆ G4RootNtupleManager

◆ G4RootPNtupleManager

Field Documentation

◆ fBookingManager

◆ fFileManager

◆ fFileNumber

◆ fFirstId

◆ fkClass

◆ fLockFirstId

◆ fNtupleBuilder

◆ fNtupleDescriptionVector

◆ fNtupleVector

◆ fRowWise

◆ fState