G4RootMainNtupleManager Class Reference

#include <G4RootMainNtupleManager.hh>

Inheritance diagram for G4RootMainNtupleManager:

Public Member Functions
	G4RootMainNtupleManager (G4RootNtupleManager *ntupleBuilder, G4NtupleBookingManager *bookingManager, G4bool rowWise, G4int fileNumber, const G4AnalysisManagerState &state)
	~G4RootMainNtupleManager ()
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
virtual	~G4BaseAnalysisManager ()
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () const

Protected Member Functions
void	CreateNtuple (RootNtupleDescription *ntupleDescription, G4bool warn=true)
G4bool	Merge ()
G4bool	Reset (G4bool deleteNtuple)
void	SetFileManager (std::shared_ptr< G4RootFileManager > fileManager)
void	SetRowWise (G4bool rowWise)
std::shared_ptr< G4RootFile >	GetNtupleFile (RootNtupleDescription *ntupleDescription) const
const std::vector< tools::wroot::ntuple * > &	GetNtupleVector ()
unsigned int	GetBasketEntries () const

Friends
class	G4RootPNtupleManager
class	G4RootNtupleManager

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

Detailed Description

Definition at line 56 of file G4RootMainNtupleManager.hh.

Constructor & Destructor Documentation

G4RootMainNtupleManager()

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

explicit

Definition at line 38 of file G4RootMainNtupleManager.cc.

 : G4BaseAnalysisManager(state),
   fNtupleBuilder(ntupleBuilder),
   fBookingManager(bookingManager),
   fFileManager(nullptr),
   fRowWise(rowWise),
   fFileNumber(fileNumber),
   fNtupleVector(),
   fNtupleDescriptionVector()
{}

~G4RootMainNtupleManager()

G4RootMainNtupleManager::~G4RootMainNtupleManager

(

)

Definition at line 55 of file G4RootMainNtupleManager.cc.

{
  // ntuple objects are deleted automatically when closing a file 
}

Member Function Documentation

CreateNtuple()

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

protected

Definition at line 65 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 ) {
      G4ExceptionDescription description;
      description 
        << "Ntuple file must be defined first."  << G4endl 
        << "Cannot create main ntuple.";
        G4Exception("G4RootMainAnalysisManager::CreateNtuple",
                  "Analysis_W002", JustWarning, description);
      }
    return;
  }
 
  // Get ntuple booking
  auto ntupleBooking = ntupleDescription->fNtupleBooking;
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("create", "main ntuple", ntupleBooking.name());
#endif
 
  // 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);
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL3() ) 
    fState.GetVerboseL3()
      ->Message("create", "main ntuple", ntupleBooking.name());
#endif
}

GetBasketEntries()

unsigned int G4RootMainNtupleManager::GetBasketEntries ( ) const

inlineprotected

Definition at line 103 of file G4RootMainNtupleManager.hh.

{ return fNtupleBuilder->GetBasketEntries(); }

GetNtupleFile()

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

protected

Definition at line 145 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 81 of file G4RootMainNtupleManager.hh.

      { return fNtupleVector; }

Merge()

G4bool G4RootMainNtupleManager::Merge ( )

protected

Definition at line 110 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;
}

Reset()

G4bool G4RootMainNtupleManager::Reset ( G4bool  deleteNtuple )

protected

Definition at line 129 of file G4RootMainNtupleManager.cc.

{
  for ( auto ntuple : fNtupleVector ) {
    if ( deleteNtuple ) {
      delete ntuple;
    }  
  }
 
  fNtupleVector.clear(); 
  fNtupleDescriptionVector.clear(); 
  
  return true;
}

SetFileManager()

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

inlineprotected

Definition at line 96 of file G4RootMainNtupleManager.hh.

{ fFileManager = fileManager; }

SetRowWise()

void G4RootMainNtupleManager::SetRowWise ( G4bool  rowWise )

inlineprotected

Definition at line 100 of file G4RootMainNtupleManager.hh.

{ fRowWise = rowWise; }

Friends And Related Function Documentation

G4RootNtupleManager

friend class G4RootNtupleManager

friend

Definition at line 59 of file G4RootMainNtupleManager.hh.

G4RootPNtupleManager

friend class G4RootPNtupleManager

friend

Definition at line 58 of file G4RootMainNtupleManager.hh.

---

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

• G4RootMainNtupleManager.hh
• G4RootMainNtupleManager.cc