G4RootMainNtupleManager Class Reference

#include <G4RootMainNtupleManager.hh>

Inheritance diagram for G4RootMainNtupleManager:

Collaboration diagram for G4RootMainNtupleManager:

Public Member Functions
	G4RootMainNtupleManager (G4RootNtupleManager *ntupleBuilder, 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 Types
using	NtupleType = tools::wroot::ntuple
using	NtupleDescriptionType = G4TNtupleDescription< NtupleType >

Protected Member Functions
void	CreateNtuple (const tools::ntuple_booking &ntupleBooking, G4bool warn=true)
void	CreateNtuplesFromBooking ()
G4bool	Merge ()
G4bool	Reset (G4bool deleteNtuple)
void	SetNtupleFile (std::shared_ptr< tools::wroot::file > rfile)
void	SetNtupleDirectory (tools::wroot::directory *directory)
std::shared_ptr < tools::wroot::file >	GetNtupleFile () const
tools::wroot::directory *	GetNtupleDirectory () const
const std::vector < NtupleDescriptionType * > &	GetNtupleDescriptionVector ()
const std::vector < tools::wroot::ntuple * > &	GetNtupleVector ()
unsigned int	GetBasketSize () 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 51 of file G4RootMainNtupleManager.hh.

Member Typedef Documentation

using G4RootMainNtupleManager::NtupleDescriptionType = G4TNtupleDescription<NtupleType>

protected

Definition at line 64 of file G4RootMainNtupleManager.hh.

using G4RootMainNtupleManager::NtupleType = tools::wroot::ntuple

protected

Definition at line 63 of file G4RootMainNtupleManager.hh.

Constructor & Destructor Documentation

G4RootMainNtupleManager::G4RootMainNtupleManager ( G4RootNtupleManager *  ntupleBuilder, const G4AnalysisManagerState &  state  )

explicit

Definition at line 38 of file G4RootMainNtupleManager.cc.

 : G4BaseAnalysisManager(state),
   fNtupleBuilder(ntupleBuilder),
   fNtupleDirectory(nullptr),
   fNtupleVector()
{}

G4RootMainNtupleManager::~G4RootMainNtupleManager

(

)

Definition at line 47 of file G4RootMainNtupleManager.cc.

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

Member Function Documentation

void G4RootMainNtupleManager::CreateNtuple ( const tools::ntuple_booking &  ntupleBooking, G4bool  warn = true  )

protected

Definition at line 61 of file G4RootMainNtupleManager.cc.

{
// Create ntuple from booking if file was open

  // Check that file is set
  if ( ! fNtupleDirectory ) {
    if ( warn ) {
      G4ExceptionDescription description;
      description 
        << "      " << "Ntuple file must be defined first." 
        << G4endl 
        << "      " << "Cannot create main ntuples from builder.";
        G4Exception("G4RootAnalysisManager::CreateNtuplesFromBooking",
                  "Analysis_W002", JustWarning, description);
      }
    return;
  }

#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("create", "main ntuple", ntupleBooking.name());
#endif

  // Create ntuple
  auto ntuple = new tools::wroot::ntuple(*fNtupleDirectory, ntupleBooking);
         // ntuple object is deleted automatically when closing a file
  auto basketSize = fNtupleBuilder->GetBasketSize();
  ntuple->set_basket_size(basketSize);

  fNtupleVector.push_back(ntuple);

#ifdef G4VERBOSE
  if ( fState.GetVerboseL3() ) 
    fState.GetVerboseL3()
      ->Message("create", "main ntuple", ntupleBooking.name());
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4RootMainNtupleManager::CreateNtuplesFromBooking ( )

protected

Definition at line 102 of file G4RootMainNtupleManager.cc.

{
// Create ntuple from booking in master 

  // Check that file is set
  if ( ! fNtupleDirectory ) {
    G4ExceptionDescription description;
    description 
      << "      " << "Ntuple file must be defined first." 
      << G4endl 
      << "      " << "Cannot create main ntuples from builder.";
      G4Exception("G4RootAnalysisManager::CreateNtuplesFromBooking",
                "Analysis_W002", JustWarning, description);
    return;
  }

  auto& ntupleDescriptionVector 
    = fNtupleBuilder->GetNtupleDescriptionVector();

  for ( auto ntupleDescription : ntupleDescriptionVector ) {    
    CreateNtuple(ntupleDescription->fNtupleBooking);
  }
}   

Here is the call graph for this function:

unsigned int G4RootMainNtupleManager::GetBasketSize ( ) const

protected

const std::vector<NtupleDescriptionType*>& G4RootMainNtupleManager::GetNtupleDescriptionVector ( )

inlineprotected

Definition at line 79 of file G4RootMainNtupleManager.hh.

      { return fNtupleBuilder->GetNtupleDescriptionVector(); }

tools::wroot::directory * G4RootMainNtupleManager::GetNtupleDirectory ( ) const

inlineprotected

Definition at line 102 of file G4RootMainNtupleManager.hh.

{ return fNtupleDirectory; }

std::shared_ptr< tools::wroot::file > G4RootMainNtupleManager::GetNtupleFile ( ) const

inlineprotected

Definition at line 99 of file G4RootMainNtupleManager.hh.

{ return fNtupleFile; }

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

inlineprotected

Definition at line 81 of file G4RootMainNtupleManager.hh.

      { return fNtupleVector; }

G4bool G4RootMainNtupleManager::Merge ( )

protected

Definition at line 127 of file G4RootMainNtupleManager.cc.

{
  for ( auto ntuple : fNtupleVector ) {
    ntuple->merge_number_of_entries();
  }

  return true;
}

G4bool G4RootMainNtupleManager::Reset ( G4bool  deleteNtuple )

protected

Definition at line 137 of file G4RootMainNtupleManager.cc.

{
  for ( auto ntuple : fNtupleVector ) {
    if ( deleteNtuple ) {
      delete ntuple;
    }  
  }

  fNtupleVector.clear(); 
  
  return true;
}

void G4RootMainNtupleManager::SetNtupleDirectory ( tools::wroot::directory *  directory )

inlineprotected

Definition at line 96 of file G4RootMainNtupleManager.hh.

{ fNtupleDirectory = directory; }

void G4RootMainNtupleManager::SetNtupleFile ( std::shared_ptr< tools::wroot::file >  rfile )

inlineprotected

Definition at line 93 of file G4RootMainNtupleManager.hh.

{ fNtupleFile = rfile; }

Friends And Related Function Documentation

friend class G4RootNtupleManager

friend

Definition at line 54 of file G4RootMainNtupleManager.hh.

friend class G4RootPNtupleManager

friend

Definition at line 53 of file G4RootMainNtupleManager.hh.

---

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

• geant4.10.03.p01/source/analysis/root/include/G4RootMainNtupleManager.hh
• geant4.10.03.p01/source/analysis/root/src/G4RootMainNtupleManager.cc