G4RootNtupleFileManager Class Reference

#include <G4RootNtupleFileManager.hh>

Inheritance diagram for G4RootNtupleFileManager:

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

Friends
class	G4RootMpiNtupleFileManager

Additional Inherited Members
Protected Attributes inherited from G4VNtupleFileManager
const G4AnalysisManagerState &	fState
G4String	fFileType
std::shared_ptr< G4NtupleBookingManager >	fBookingManager

Detailed Description

Definition at line 49 of file G4RootNtupleFileManager.hh.

Constructor & Destructor Documentation

G4RootNtupleFileManager()

G4RootNtupleFileManager::G4RootNtupleFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 62 of file G4RootNtupleFileManager.cc.

 : G4VNtupleFileManager(state, "root"),
   fIsInitialized(false),
   fNofNtupleFiles(0),
   fNtupleRowWise(false),
   fNtupleRowMode(true),
   fNtupleMergeMode(G4NtupleMergeMode::kNone),
   fNtupleManager(nullptr),
   fSlaveNtupleManager(nullptr),
   fFileManager(nullptr)
{
  if ( G4Threading::IsMasterThread() && fgMasterInstance ) {
    G4ExceptionDescription description;
    description 
      << "      " 
      << "G4RootNtupleFileManager already exists." 
      << "Cannot create another instance.";
    G4Exception("G4RootNtupleFileManager::G4RootNtupleFileManager()",
                "Analysis_F001", FatalException, description);
  }
  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()

G4RootNtupleFileManager::~G4RootNtupleFileManager ( )

virtual

Definition at line 92 of file G4RootNtupleFileManager.cc.

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

Member Function Documentation

ActionAtCloseFile()

G4bool G4RootNtupleFileManager::ActionAtCloseFile ( G4bool  reset )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 422 of file G4RootNtupleFileManager.cc.

{
  auto finalResult = true;
 
  // close files
  if ( fNtupleMergeMode != G4NtupleMergeMode::kSlave )  {
    auto result = CloseNtupleFiles();
    finalResult = finalResult && result;
  }
 
  if ( ! reset ) {
    // The ntuples must be always reset when closing file) 
    auto result = Reset();
    if ( ! result ) {
      G4ExceptionDescription description;
      description << "      " << "Resetting data failed";
      G4Exception("G4RootNtupleFileManager::CloseFile()",
                "Analysis_W021", JustWarning, description);
    }
    finalResult = finalResult && result;
  }
 
  return finalResult;
}

ActionAtOpenFile()

G4bool G4RootNtupleFileManager::ActionAtOpenFile ( const G4String &  fileName )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 347 of file G4RootNtupleFileManager.cc.

{
  // Check if fNtupleBookingManager is set
 
  auto finalResult = true;
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone || 
       fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
 
#ifdef G4VERBOSE
    G4String objectType = "analysis file";
    if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) {
      objectType = "main analysis file";
    }
    if ( fState.GetVerboseL4() ) 
      fState.GetVerboseL4()->Message("open", objectType, fileName);
#endif
 
    // Creating files is triggered from CreateNtuple
    fNtupleManager->CreateNtuplesFromBooking(
      fBookingManager->GetNtupleBookingVector());
 
#ifdef G4VERBOSE
    if ( fState.GetVerboseL1() )  {
      fState.GetVerboseL1()->Message("open", objectType, fileName, finalResult);
    }
#endif
  }
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave )  {
    // G4cout << "Going to create slave ntuples from main" << G4endl;
    fSlaveNtupleManager->CreateNtuplesFromMain();
  }
 
  return finalResult;
}  

ActionAtWrite()

G4bool G4RootNtupleFileManager::ActionAtWrite ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 386 of file G4RootNtupleFileManager.cc.

{
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ) {
    return true;
  }
  
  auto finalResult = true;
 
  G4String ntupleType;
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) ntupleType = "main ntuples";
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) ntupleType = "slave ntuples";
 
#ifdef G4VERBOSE 
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("merge", ntupleType, "");
#endif
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    auto result = fNtupleManager->Merge();
    finalResult = result && finalResult;
  }  
  
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) {
    auto result = fSlaveNtupleManager->Merge();
    finalResult = result && finalResult;
  }
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()->Message("merge", ntupleType, "");
#endif
  
  return finalResult;
}

CreateNtupleManager()

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

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 272 of file G4RootNtupleFileManager.cc.

{
// Create and return ntuple manager.
// If ntuple merging is activated, managers of different types are created
// on master/worker.
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "ntuple manager", "");
#endif
 
  // 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 ) nofMainManagers = 1;
             // create one manager if merging required into the histos & profiles files
      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, fgMasterInstance->fBookingManager, mainNtupleManager, fNtupleRowWise, fNtupleRowMode); 
      activeNtupleManager = fSlaveNtupleManager;
      break;
  }
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL3() ) {
    G4String mergeMode;
    switch ( fNtupleMergeMode ) {
      case G4NtupleMergeMode::kNone:
        mergeMode = "";
        break;
      case G4NtupleMergeMode::kMain:
        mergeMode = "main ";
        break;
      case G4NtupleMergeMode::kSlave:
        mergeMode = "slave ";
        break;
    }
    fState.GetVerboseL3()->Message("create", mergeMode + "ntuple manager", "");
  }
#endif
 
  fIsInitialized = true;
 
  return activeNtupleManager;
}

GetMergeMode()

G4NtupleMergeMode G4RootNtupleFileManager::GetMergeMode ( ) const

inline

Definition at line 102 of file G4RootNtupleFileManager.hh.

{ return fNtupleMergeMode; }

GetNtupleManager()

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

inline

Definition at line 108 of file G4RootNtupleFileManager.hh.

{ return fNtupleManager; }

IsNtupleMergingSupported()

G4bool G4RootNtupleFileManager::IsNtupleMergingSupported ( ) const

inlineoverridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 105 of file G4RootNtupleFileManager.hh.

{ return true; }

Reset()

G4bool G4RootNtupleFileManager::Reset ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 448 of file G4RootNtupleFileManager.cc.

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

Referenced by ActionAtCloseFile().

SetBasketEntries()

void G4RootNtupleFileManager::SetBasketEntries ( unsigned int  basketEntries )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 266 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketEntries(basketEntries);
}

SetBasketSize()

void G4RootNtupleFileManager::SetBasketSize ( unsigned int  basketSize )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 260 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketSize(basketSize);
}

SetFileManager()

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

inline

Definition at line 98 of file G4RootNtupleFileManager.hh.

{ fFileManager = fileManager; }

SetNtupleMerging()

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

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 205 of file G4RootNtupleFileManager.cc.

{
  if ( fIsInitialized ) {
      G4ExceptionDescription description;
      description 
        << "Cannot change merging mode." << G4endl
        << "The function must be called before OpenFile().";
      MergingException("SetNtupleMerging", description);
      return;
  }
 
  // Set ntuple merging mode 
  SetNtupleMergingMode(mergeNtuples, nofNtupleFiles);
}

SetNtupleRowWise()

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

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 223 of file G4RootNtupleFileManager.cc.

{
#ifdef G4VERBOSE
  // 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"; 
  }
 
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()
      ->Message("set", "ntuple merging row mode", rowWiseMode);
#endif
 
  // 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 Function Documentation

G4RootMpiNtupleFileManager

friend class G4RootMpiNtupleFileManager

friend

Definition at line 51 of file G4RootNtupleFileManager.hh.

---

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

• G4RootNtupleFileManager.hh
• G4RootNtupleFileManager.cc