G4RootMainNtupleManager Class Reference

#include <G4RootMainNtupleManager.hh>

Inheritance diagram for G4RootMainNtupleManager:

Public Member Functions
	G4RootMainNtupleManager (G4RootNtupleManager *ntupleBuilder, std::shared_ptr< G4NtupleBookingManager > bookingManager, G4bool rowWise, G4int fileNumber, const G4AnalysisManagerState &state)
	G4RootMainNtupleManager ()=delete
	~G4RootMainNtupleManager () override=default
void	CreateNtuplesFromBooking ()
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
	G4BaseAnalysisManager ()=delete
virtual	~G4BaseAnalysisManager ()=default
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () const
G4int	GetCycle () const

Protected Member Functions
void	CreateNtuple (RootNtupleDescription *ntupleDescription, G4bool warn=true)
G4bool	Delete (G4int id)
G4bool	Merge ()
G4bool	Reset ()
void	ClearData ()
void	SetFileManager (std::shared_ptr< G4RootFileManager > fileManager)
void	SetRowWise (G4bool rowWise)
std::shared_ptr< G4RootFile >	GetNtupleFile (RootNtupleDescription *ntupleDescription) const
void	SetNewCycle (G4bool value)
G4bool	GetNewCycle () const
const std::vector< tools::wroot::ntuple * > &	GetNtupleVector ()
unsigned int	GetBasketEntries () const
Protected Member Functions inherited from G4BaseAnalysisManager
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Friends
class	G4RootPNtupleManager
class	G4RootNtupleManager

Additional Inherited Members
Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState
G4int	fFirstId { 0 }
G4bool	fLockFirstId { false }

Detailed Description

Definition at line 59 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()

G4RootMainNtupleManager::~G4RootMainNtupleManager ( )

overridedefault

Member Function Documentation

ClearData()

void G4RootMainNtupleManager::ClearData ( )

protected

Definition at line 200 of file G4RootMainNtupleManager.cc.

{
  fNtupleDescriptionVector.clear();
  fNtupleVector.clear();
 
  Message(G4Analysis::kVL2, "clear", "main ntuples");
}

CreateNtuple()

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

protected

Definition at line 105 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 == nullptr ) {
    if ( warn ) {
      Warn("Ntuple file must be defined first.\n"
           "Cannot create main ntuple.",
           fkClass, "CreateNtuple");
    }
    return;
  }
 
  // Create ntuple from g4 booking
  auto g4NtupleBooking = ntupleDescription->GetG4NtupleBooking();
  auto index = CreateNtupleFromBooking(g4NtupleBooking, ntupleFile);
 
  // Return if ntuple was not created
  if (index == G4Analysis::kInvalidId) return;
 
  // Allocate the ntuple description pair vector element(s) if needed
  while ( index >= G4int(fNtupleDescriptionVector.size()) ) {
    fNtupleDescriptionVector.push_back(std::make_pair(nullptr, nullptr));
  }
 
  // Save ntuple description pair in vectors
  fNtupleDescriptionVector[index] = std::make_pair(ntupleDescription, ntupleFile);
}

CreateNtuplesFromBooking()

void G4RootMainNtupleManager::CreateNtuplesFromBooking

(

)

Definition at line 221 of file G4RootMainNtupleManager.cc.

{
// Create ntuples from booking (without creating ntuple description)
// This function is triggered from workers at new cycle.
 
  for (auto [ntupleDescription, ntupleFile] : fNtupleDescriptionVector) {
    CreateNtupleFromBooking(ntupleDescription->GetG4NtupleBooking(), ntupleFile);
  }
 
  SetNewCycle(false);
}

Delete()

G4bool G4RootMainNtupleManager::Delete ( G4int id )

protected

Definition at line 138 of file G4RootMainNtupleManager.cc.

{
  if (fNtupleVector.empty()) {
    // Main ntuples are delete with each new cycle
    return true;
  }
 
  // Proceed with deleting if vector is not empty
 
  Message(kVL4, "delete", "main ntuple ntupleId: " + to_string(id));
 
  // Get ntuple description
  auto index = id - fFirstId;
  if ( index < 0 || index >= G4int(fNtupleVector.size()) ) {
    G4Analysis::Warn("Main ntuple " + to_string(id) + " does not exist.",
      fkClass, "Delete");
    return false;
  }
 
  // Delete main ntuple and update ntuple vector
  delete fNtupleVector[index];
  fNtupleVector[index] = nullptr;
 
  Message(kVL3, "delete", "main ntuple ntupleId: " + to_string(id));
 
  return true;
}

GetBasketEntries()

unsigned int G4RootMainNtupleManager::GetBasketEntries ( ) const

inlineprotected

Definition at line 125 of file G4RootMainNtupleManager.hh.

{ return fNtupleBuilder->GetBasketEntries(); }

GetNewCycle()

G4bool G4RootMainNtupleManager::GetNewCycle ( ) const

inlineprotected

Definition at line 131 of file G4RootMainNtupleManager.hh.

{ return fNewCycle; }

GetNtupleFile()

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

protected

Definition at line 210 of file G4RootMainNtupleManager.cc.

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

GetNtupleVector()

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

inlineprotected

Definition at line 93 of file G4RootMainNtupleManager.hh.

      { return fNtupleVector; }

Merge()

G4bool G4RootMainNtupleManager::Merge ( )

protected

Definition at line 167 of file G4RootMainNtupleManager.cc.

{
  std::size_t counter = 0;
 
  for ( auto ntuple : fNtupleVector ) {
    // skip deleted ntuples
    if (ntuple == nullptr) continue;
 
    ntuple->merge_number_of_entries();
 
    // Notify ntuple description that file is not empty
    if (ntuple->entries() != 0u) {
      auto ntupleDescription = fNtupleDescriptionVector.at(counter).first;
      ntupleDescription->SetHasFill(true);
    }
    ++counter;
  }
 
  return true;
}

Reset()

G4bool G4RootMainNtupleManager::Reset ( )

protected

Definition at line 189 of file G4RootMainNtupleManager.cc.

{
  // The ntuples will be recreated with new cycle or new open file.
  // Ntuple objects are deleted automatically when closing a file
 
  fNtupleVector.clear();
 
  return true;
}

SetFileManager()

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

inlineprotected

Definition at line 116 of file G4RootMainNtupleManager.hh.

{
  fFileManager = std::move(fileManager);
}

SetNewCycle()

void G4RootMainNtupleManager::SetNewCycle ( G4bool value )

inlineprotected

Definition at line 128 of file G4RootMainNtupleManager.hh.

{ fNewCycle = value; }

Referenced by CreateNtuplesFromBooking().

SetRowWise()

void G4RootMainNtupleManager::SetRowWise ( G4bool rowWise )

inlineprotected

Definition at line 122 of file G4RootMainNtupleManager.hh.

{ fRowWise = rowWise; }

Friends And Related Symbol Documentation

G4RootNtupleManager

friend class G4RootNtupleManager

friend

Definition at line 62 of file G4RootMainNtupleManager.hh.

G4RootPNtupleManager

friend class G4RootPNtupleManager

friend

Definition at line 61 of file G4RootMainNtupleManager.hh.

---

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

• G4RootMainNtupleManager.hh
• G4RootMainNtupleManager.cc