G4RootNtupleFileManager Class Reference

#include <G4RootNtupleFileManager.hh>

Inheritance diagram for G4RootNtupleFileManager:

Public Member Functions
	G4RootNtupleFileManager (const G4AnalysisManagerState &state)
	G4RootNtupleFileManager ()=delete
	~G4RootNtupleFileManager () override
void	SetNtupleMerging (G4bool mergeNtuples, G4int nofReducedNtupleFiles=0) override
void	SetNtupleRowWise (G4bool rowWise, G4bool rowMode=true) override
void	SetBasketSize (unsigned int basketSize) override
void	SetBasketEntries (unsigned int basketEntries) override
G4bool	ActionAtOpenFile (const G4String &fileName) override
G4bool	ActionAtWrite () override
G4bool	ActionAtCloseFile () override
G4bool	Reset () override
G4bool	IsNtupleMergingSupported () const override
std::shared_ptr< G4VNtupleManager >	CreateNtupleManager () override
void	SetFileManager (std::shared_ptr< G4RootFileManager > fileManager)
G4NtupleMergeMode	GetMergeMode () const override
std::shared_ptr< G4RootNtupleManager >	GetNtupleManager () const
Public Member Functions inherited from G4VNtupleFileManager
	G4VNtupleFileManager (const G4AnalysisManagerState &state, G4String fileType)
	G4VNtupleFileManager ()=delete
virtual	~G4VNtupleFileManager ()=default
	G4VNtupleFileManager (const G4VNtupleFileManager &rhs)=delete
G4VNtupleFileManager &	operator= (const G4VNtupleFileManager &rhs)=delete
virtual void	SetBookingManager (std::shared_ptr< G4NtupleBookingManager > bookingManager)
G4String	GetFileType () const

Friends
class	G4RootMpiNtupleFileManager

Additional Inherited Members
Protected Member Functions inherited from G4VNtupleFileManager
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
Protected Attributes inherited from G4VNtupleFileManager
const G4AnalysisManagerState &	fState
G4String	fFileType
std::shared_ptr< G4NtupleBookingManager >	fBookingManager { nullptr }

Detailed Description

Definition at line 46 of file G4RootNtupleFileManager.hh.

Constructor & Destructor Documentation

G4RootNtupleFileManager() [1/2]

G4RootNtupleFileManager::G4RootNtupleFileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 50 of file G4RootNtupleFileManager.cc.

 : G4VNtupleFileManager(state, "root")
{
  if ( G4Threading::IsMasterThread() ) fgMasterInstance = this;
 
  // Do not merge ntuples by default
  // Merging may require user code migration as analysis manager
  // must be created both on master and workers.
  auto mergeNtuples = false;
  SetNtupleMergingMode(mergeNtuples, fNofNtupleFiles);
}

G4RootNtupleFileManager() [2/2]

G4RootNtupleFileManager::G4RootNtupleFileManager ( )

delete

~G4RootNtupleFileManager()

G4RootNtupleFileManager::~G4RootNtupleFileManager ( )

override

Definition at line 63 of file G4RootNtupleFileManager.cc.

{
  if ( fState.GetIsMaster() ) fgMasterInstance = nullptr;
}

Member Function Documentation

ActionAtCloseFile()

G4bool G4RootNtupleFileManager::ActionAtCloseFile ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 350 of file G4RootNtupleFileManager.cc.

{
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave)  {
    fSlaveNtupleManager->SetNewCycle(false);
    return true;
  }
 
  return CloseNtupleFiles();
}

ActionAtOpenFile()

G4bool G4RootNtupleFileManager::ActionAtOpenFile ( const G4String & fileName )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 292 of file G4RootNtupleFileManager.cc.

{
  // Check if fNtupleBookingManager is set
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ||
       fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
 
    G4String objectType = "analysis file";
    if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) {
      objectType = "main analysis file";
    }
    Message(kVL4, "open", objectType, fileName);
 
    // Creating files is triggered from CreateNtuple
    fNtupleManager->CreateNtuplesFromBooking(
      fBookingManager->GetNtupleBookingVector());
 
    Message(kVL1, "open", objectType, fileName);
  }
 
  // Creating ntuples from main is triggered from the first Fill call
  // if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave )  {
  //   // G4cout << "Going to create slave ntuples from main" << G4endl;
  //   fSlaveNtupleManager->CreateNtuplesFromMain();
  // }
 
  return true;
}

ActionAtWrite()

G4bool G4RootNtupleFileManager::ActionAtWrite ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 322 of file G4RootNtupleFileManager.cc.

{
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ) {
    return true;
  }
 
  auto result = true;
 
  G4String ntupleType;
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) ntupleType = "main ntuples";
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) ntupleType = "slave ntuples";
 
  Message(kVL4, "merge", ntupleType);
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Merge();
  }
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) {
    result &= fSlaveNtupleManager->Merge();
  }
 
  Message(kVL2, "merge", ntupleType, "", result);
 
  return result;
}

CreateNtupleManager()

std::shared_ptr< G4VNtupleManager > G4RootNtupleFileManager::CreateNtupleManager ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 225 of file G4RootNtupleFileManager.cc.

{
// Create and return ntuple manager.
// If ntuple merging is activated, managers of different types are created
// on master/worker.
 
  Message(kVL4, "create", "ntuple manager");
 
  // Check that file manager and anaysis manager are set !
 
  std::shared_ptr<G4VNtupleManager> activeNtupleManager = nullptr;
  switch ( fNtupleMergeMode )
  {
    case G4NtupleMergeMode::kNone:
      fNtupleManager
        = make_shared<G4RootNtupleManager>(
            fState, fBookingManager, 0, 0, fNtupleRowWise, fNtupleRowMode);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
 
    case G4NtupleMergeMode::kMain: {
      G4int nofMainManagers = fNofNtupleFiles;
      if (nofMainManagers == 0) {
        // create one manager if merging required into the histos & profiles files
        nofMainManagers = 1;
      }
      fNtupleManager
        = make_shared<G4RootNtupleManager>(
            fState, fBookingManager, nofMainManagers, fNofNtupleFiles, fNtupleRowWise, fNtupleRowMode);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
    }
 
    case G4NtupleMergeMode::kSlave:
      fNtupleManager = fgMasterInstance->fNtupleManager;
        // The master class is used only in Get* functions
      auto mainNtupleManager
        = fNtupleManager->GetMainNtupleManager(GetNtupleFileNumber());
      fSlaveNtupleManager
        = make_shared<G4RootPNtupleManager>(
            fState, fBookingManager, mainNtupleManager, fNtupleRowWise, fNtupleRowMode);
      activeNtupleManager = fSlaveNtupleManager;
      break;
  }
 
  G4String mergeMode;
  switch ( fNtupleMergeMode ) {
    case G4NtupleMergeMode::kNone:
      mergeMode = "";
      break;
    case G4NtupleMergeMode::kMain:
      mergeMode = "main ";
      break;
    case G4NtupleMergeMode::kSlave:
      mergeMode = "slave ";
      break;
  }
  Message(kVL3, "create", mergeMode + "ntuple manager");
 
  fIsInitialized = true;
 
  return activeNtupleManager;
}

GetMergeMode()

G4NtupleMergeMode G4RootNtupleFileManager::GetMergeMode ( ) const

inlineoverridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 103 of file G4RootNtupleFileManager.hh.

{ return fNtupleMergeMode; }

GetNtupleManager()

std::shared_ptr< G4RootNtupleManager > G4RootNtupleFileManager::GetNtupleManager ( ) const

inline

Definition at line 109 of file G4RootNtupleFileManager.hh.

{ return fNtupleManager; }

IsNtupleMergingSupported()

G4bool G4RootNtupleFileManager::IsNtupleMergingSupported ( ) const

inlineoverridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 106 of file G4RootNtupleFileManager.hh.

{ return true; }

Reset()

G4bool G4RootNtupleFileManager::Reset ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 361 of file G4RootNtupleFileManager.cc.

{
// Reset ntuples
 
  auto result = true;
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ||
       fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Reset();
  }
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) {
    fSlaveNtupleManager->Reset();
  }
 
  return result;
}

SetBasketEntries()

void G4RootNtupleFileManager::SetBasketEntries ( unsigned int basketEntries )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 219 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketEntries(basketEntries);
}

SetBasketSize()

void G4RootNtupleFileManager::SetBasketSize ( unsigned int basketSize )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 213 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketSize(basketSize);
}

SetFileManager()

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

inline

Definition at line 97 of file G4RootNtupleFileManager.hh.

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

SetNtupleMerging()

void G4RootNtupleFileManager::SetNtupleMerging ( G4bool mergeNtuples, G4int nofReducedNtupleFiles = 0 )

overridevirtual

---

Reimplemented from G4VNtupleFileManager.

Definition at line 163 of file G4RootNtupleFileManager.cc.

{
  if ( fIsInitialized ) {
    Warn("Cannot change merging mode.\n"
         "The function must be called before OpenFile().",
         fkClass, "SetNtupleMerging");
    return;
  }
 
  // Set ntuple merging mode
  SetNtupleMergingMode(mergeNtuples, nofNtupleFiles);
}

SetNtupleRowWise()

void G4RootNtupleFileManager::SetNtupleRowWise ( G4bool rowWise, G4bool rowMode = true )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 179 of file G4RootNtupleFileManager.cc.

{
 
  // Print info even when setting makes no effect
  // (as we do not get printed the default setting in the output)
  G4String rowWiseMode;
  if ( rowWise ) {
    rowWiseMode = "row-wise with extra branch";
  }
  else if ( rowMode ) {
    rowWiseMode = "row-wise";
  }
  else {
    rowWiseMode = "column-wise";
  }
 
  Message(kVL1, "set", "ntuple merging row mode", rowWiseMode);
 
  // Do nothing if the mode is not changed
  if ( fNtupleRowWise == rowWise && fNtupleRowMode == rowMode ) return;
 
  fNtupleRowWise = rowWise;
  fNtupleRowMode = rowMode;
 
  if ( fNtupleManager ) {
    fNtupleManager->SetNtupleRowWise(rowWise, rowMode);
  }
 
  if ( fSlaveNtupleManager ) {
    fSlaveNtupleManager->SetNtupleRowWise(rowWise, rowMode);
  }
}

Friends And Related Symbol Documentation

G4RootMpiNtupleFileManager

friend class G4RootMpiNtupleFileManager

friend

Definition at line 48 of file G4RootNtupleFileManager.hh.

---

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

• G4RootNtupleFileManager.hh
• G4RootNtupleFileManager.cc