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 ()
tools::wroot::directory *	GetHistoDirectory () const
tools::wroot::directory *	GetNtupleDirectory () 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	GetPlotFileName () const
G4String	GetFileType () const

Private Attributes
std::unique_ptr< tools::wroot::file >	fFile
tools::wroot::directory *	fHistoDirectory
tools::wroot::directory *	fNtupleDirectory

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::G4RootFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 44 of file G4RootFileManager.cc.

 : G4VFileManager(state),
   fFile(nullptr),
   fHistoDirectory(nullptr),
   fNtupleDirectory(nullptr)
{}

~G4RootFileManager()

G4RootFileManager::~G4RootFileManager ( )

virtual

Definition at line 52 of file G4RootFileManager.cc.

{}

Member Function Documentation

CloseFile()

G4bool G4RootFileManager::CloseFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 114 of file G4RootFileManager.cc.

{
  // close file
  fFile->close();  
  fLockFileName = false;
  fIsOpenFile = false;

  return true;
} 

CreateHistoDirectory()

G4bool G4RootFileManager::CreateHistoDirectory

(

)

Definition at line 125 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:

CreateNtupleDirectory()

G4bool G4RootFileManager::CreateNtupleDirectory

(

)

Definition at line 159 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:

GetHistoDirectory()

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

inline

Definition at line 75 of file G4RootFileManager.hh.

{ return fHistoDirectory; }

GetNtupleDirectory()

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

inline

Definition at line 78 of file G4RootFileManager.hh.

{ return fNtupleDirectory; }

OpenFile()

G4bool G4RootFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 59 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 = G4Analysis::make_unique<tools::wroot::file>(G4cout, name);
  fFile->add_ziper('Z',tools::compress_buffer);
  fFile->set_compression(fState.GetCompressionLevel());
  
  if ( ! fFile->is_open() ) {
    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;

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

  fIsOpenFile = true;

  return true;
}  

Here is the call graph for this function:

WriteFile()

G4bool G4RootFileManager::WriteFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 95 of file G4RootFileManager.cc.

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("write", "file", GetFullFileName());
#endif

  unsigned int n;
  auto result = fFile->write(n);

#ifdef G4VERBOSE
  if ( fState.GetVerboseL1() ) 
    fState.GetVerboseL1()->Message("write", "file", GetFullFileName(), result);
#endif

  return result;
}

Here is the call graph for this function:

Member Data Documentation

fFile

std::unique_ptr<tools::wroot::file> G4RootFileManager::fFile

private

Definition at line 68 of file G4RootFileManager.hh.

fHistoDirectory

tools::wroot::directory* G4RootFileManager::fHistoDirectory

private

Definition at line 69 of file G4RootFileManager.hh.

fNtupleDirectory

tools::wroot::directory* G4RootFileManager::fNtupleDirectory

private

Definition at line 70 of file G4RootFileManager.hh.

---

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

• G4RootFileManager.hh
• G4RootFileManager.cc