G4RootFileManager Class Reference

#include <G4RootFileManager.hh>

Inheritance diagram for G4RootFileManager:

Collaboration diagram for G4RootFileManager:

Public Member Functions
	G4RootFileManager (const G4AnalysisManagerState &state)
virtual	~G4RootFileManager ()
virtual G4bool	OpenFile (const G4String &fileName) final
virtual G4bool	WriteFile () final
virtual G4bool	CloseFile () final
G4bool	CreateHistoDirectory ()
G4bool	CreateNtupleDirectory ()
void	SetNofNtupleFiles (G4int nofFiles)
void	SetBasketSize (unsigned int basketSize)
tools::wroot::directory *	GetHistoDirectory () const
tools::wroot::directory *	GetNtupleDirectory () const
std::shared_ptr < tools::wroot::file >	GetNtupleFile (G4int index) const
tools::wroot::directory *	GetMainNtupleDirectory (G4int index) const
unsigned int	GetBasketSize () const
Public Member Functions inherited from G4VFileManager
	G4VFileManager (const G4AnalysisManagerState &state)
virtual	~G4VFileManager ()
virtual G4bool	SetFileName (const G4String &fileName) final
void	LockHistoDirectoryName ()
void	LockNtupleDirectoryName ()
G4bool	SetHistoDirectoryName (const G4String &dirName)
G4bool	SetNtupleDirectoryName (const G4String &dirName)
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
virtual	~G4BaseFileManager ()
G4String	GetFileName () const
G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
G4String	GetFileType () const

Additional Inherited Members
Protected Member Functions inherited from G4BaseFileManager
G4String	TakeOffExtension (G4String &name) const
Protected Attributes inherited from G4VFileManager
G4bool	fIsOpenFile
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fLockFileName
G4bool	fLockHistoDirectoryName
G4bool	fLockNtupleDirectoryName
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4String	fFileName

Detailed Description

Definition at line 48 of file G4RootFileManager.hh.

Constructor & Destructor Documentation

G4RootFileManager::G4RootFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 43 of file G4RootFileManager.cc.

 : G4VFileManager(state),
   fFile(nullptr),
   fHistoDirectory(nullptr),
   fNtupleDirectory(nullptr),
   fNofNtupleFiles(0),
   fNtupleFiles(),
   fMainNtupleDirectories(),
   fBasketSize(0)
{}

G4RootFileManager::~G4RootFileManager ( )

virtual

Definition at line 55 of file G4RootFileManager.cc.

{}

Member Function Documentation

G4bool G4RootFileManager::CloseFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 233 of file G4RootFileManager.cc.

{
  auto finalResult = true;

  auto result = CloseFile(fFile, GetFullFileName());
  finalResult = finalResult && result;

  auto counter = 0;
  for ( auto ntupleFile : fNtupleFiles ) {
    result = CloseFile(ntupleFile, GetNtupleFileName(counter++));
    finalResult = finalResult && result;
  }

  fLockFileName = false;
  fIsOpenFile = false;

  return finalResult;
} 

Here is the call graph for this function:

G4bool G4RootFileManager::CreateHistoDirectory

(

)

Definition at line 253 of file G4RootFileManager.cc.

{
  if ( fHistoDirectoryName == "" ) {
    // Do not create a new directory if its name is not set
    fHistoDirectory = &(fFile->dir());
    return true;
  }  
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("create", "directory for histograms", fHistoDirectoryName);
#endif
  
  fHistoDirectory = fFile->dir().mkdir(fHistoDirectoryName);
  if ( ! fHistoDirectory ) {
    G4ExceptionDescription description;
    description << "      " 
                << "cannot create directory " << fHistoDirectoryName;
    G4Exception("G4RootFileManager::CreateHistoDirectory()",
              "Analysis_W001", JustWarning, description);
    return false;       
  }       
#ifdef G4VERBOSE
  else {
    if ( fState.GetVerboseL2() ) 
      fState.GetVerboseL2()
        ->Message("create", "directory for histograms", fHistoDirectoryName);
  }    
#endif
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4RootFileManager::CreateNtupleDirectory

(

)

Definition at line 287 of file G4RootFileManager.cc.

{
  if ( fNtupleDirectoryName == "" ) {
    // Do not create a new directory if its name is not set
    fNtupleDirectory = &(fFile->dir());
    return true;
  }  
  
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()
      ->Message("create", "directory for ntuples", fNtupleDirectoryName);
#endif

  fNtupleDirectory = fFile->dir().mkdir(fNtupleDirectoryName);
  if ( ! fNtupleDirectory ) {
    G4ExceptionDescription description;
    description << "      " 
                << "cannot create directory " << fNtupleDirectoryName;
    G4Exception("G4RootFileManager::CreateNtupleDirectory()",
                "Analysis_W001", JustWarning, description);
    return false;       
  }       
#ifdef G4VERBOSE
  else {
    if ( fState.GetVerboseL2() ) 
      fState.GetVerboseL2()
        ->Message("create", "directory for ntuples", fNtupleDirectoryName);
  }    
#endif
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int G4RootFileManager::GetBasketSize ( ) const

inline

Definition at line 105 of file G4RootFileManager.hh.

{ return fBasketSize; }

tools::wroot::directory * G4RootFileManager::GetHistoDirectory ( ) const

inline

Definition at line 99 of file G4RootFileManager.hh.

{ return fHistoDirectory; }

tools::wroot::directory * G4RootFileManager::GetMainNtupleDirectory

(

G4int

index

)

const

Definition at line 339 of file G4RootFileManager.cc.

{ 
  if ( index==0 && ( ! fMainNtupleDirectories.size() ) ) return fNtupleDirectory;

  if ( index < 0 || index >= G4int(fMainNtupleDirectories.size()) ) {
    G4String inFunction = "G4RootFileManager::GetMainNtupleDirectory()";
    G4ExceptionDescription description;
    description << "      " << "main ntuple directory " << index << " does not exist.";
    G4Exception(inFunction, "Analysis_W011", JustWarning, description);
    return nullptr;         
  }

  return fMainNtupleDirectories[index]; 
}

Here is the call graph for this function:

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

inline

Definition at line 102 of file G4RootFileManager.hh.

{ return fNtupleDirectory; }

std::shared_ptr< tools::wroot::file > G4RootFileManager::GetNtupleFile

(

G4int

index

)

const

Definition at line 322 of file G4RootFileManager.cc.

{ 
  if ( index==0 && ( ! fNtupleFiles.size() ) ) return fFile;

  if ( index < 0 || index >= G4int(fNtupleFiles.size()) ) {
    G4String inFunction = "G4RootFileManager::GetNtupleFile()";
    G4ExceptionDescription description;
    description << "      " << "ntuple file " << index << " does not exist.";
    G4Exception(inFunction, "Analysis_W011", JustWarning, description);
    return nullptr;         
  }

  return fNtupleFiles[index]; 
}

Here is the call graph for this function:

G4bool G4RootFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 177 of file G4RootFileManager.cc.

{
  // Keep file name
  fFileName =  fileName;
  auto name = GetFullFileName();
  
  // delete previous file if exists
  //if ( fFile ) delete fFile;

  // create new file
  fFile = std::make_shared<tools::wroot::file>(G4cout, name);
  fFile->add_ziper('Z',tools::compress_buffer);
  fFile->set_compression(fState.GetCompressionLevel());
  
  if ( ! fFile->is_open() ) {
    fFile = nullptr;
    G4ExceptionDescription description;
    description << "      " << "Cannot open file " << fileName;
    G4Exception("G4RootAnalysisManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    return false;
  }

  // Create directories
  if ( ! CreateHistoDirectory() ) return false;
  if ( ! CreateNtupleDirectory() ) return false;

  // Open ntuple files
  OpenNtupleFiles();

  fLockFileName = true;
  fLockHistoDirectoryName = true;
  fLockNtupleDirectoryName = true;

  fIsOpenFile = true;

  return true;
}  

Here is the call graph for this function:

void G4RootFileManager::SetBasketSize ( unsigned int  basketSize )

inline

Definition at line 96 of file G4RootFileManager.hh.

{ fBasketSize = basketSize; }

void G4RootFileManager::SetNofNtupleFiles ( G4int  nofFiles )

inline

Definition at line 93 of file G4RootFileManager.hh.

{ fNofNtupleFiles = nofFiles; }

G4bool G4RootFileManager::WriteFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 217 of file G4RootFileManager.cc.

{
  auto finalResult = true;

  auto result = WriteFile(fFile, GetFullFileName());
  finalResult = finalResult && result;

  auto counter = 0;
  for ( auto ntupleFile : fNtupleFiles ) {
    result = WriteFile(ntupleFile, GetNtupleFileName(counter++));
    finalResult = finalResult && result;
  }
  return finalResult;
}

Here is the call graph for this function:

---

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

• source/geant4.10.03.p02/source/analysis/root/include/G4RootFileManager.hh
• source/geant4.10.03.p02/source/analysis/root/src/G4RootFileManager.cc