#include <G4XmlFileManager.hh>

Inheritance diagram for G4XmlFileManager:

Collaboration diagram for G4XmlFileManager:

Public Types
using	NtupleType = tools::waxml::ntuple

using	NtupleDescriptionType = G4TNtupleDescription< NtupleType >

Public Member Functions
	G4XmlFileManager (const G4AnalysisManagerState &state)

	~G4XmlFileManager ()

virtual G4bool	OpenFile (const G4String &fileName) final

virtual G4bool	WriteFile () final

virtual G4bool	CloseFile () final

G4bool	CreateHnFile ()

G4bool	CloseHnFile ()

G4bool	CreateNtupleFile (NtupleDescriptionType *ntupleDescription)

G4bool	CloseNtupleFile (NtupleDescriptionType *ntupleDescription)

std::shared_ptr< std::ofstream >	GetHnFile () 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 46 of file G4XmlFileManager.hh.

Member Typedef Documentation

using G4XmlFileManager::NtupleDescriptionType = G4TNtupleDescription<NtupleType>

Definition at line 54 of file G4XmlFileManager.hh.

using G4XmlFileManager::NtupleType = tools::waxml::ntuple

Definition at line 53 of file G4XmlFileManager.hh.

Constructor & Destructor Documentation

G4XmlFileManager::G4XmlFileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 39 of file G4XmlFileManager.cc.

  : G4VFileManager(state),
    fHnFile(nullptr)
 {
 }

G4XmlFileManager::~G4XmlFileManager ( )

Definition at line 46 of file G4XmlFileManager.cc.

47 {}

Member Function Documentation

G4bool G4XmlFileManager::CloseFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 72 of file G4XmlFileManager.cc.

 {
   // Unlock file name
   
   fLockFileName = false;
   fIsOpenFile = false;
   return true; 
 } 

G4bool G4XmlFileManager::CloseHnFile ( )

Definition at line 112 of file G4XmlFileManager.cc.

 {
   // No file may be open if no master manager is instantiated
   // and no histograms were booked
   if ( ! fHnFile.get() ) return true;
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("close", "histo file", GetFullFileName());
 #endif
 
   // close file
   tools::waxml::end(*fHnFile);
   fHnFile->close(); 
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL1() ) 
     fState.GetVerboseL1()->Message("close", "histo file", GetFullFileName());
 #endif
 
 
   return true; 
 } 

Here is the call graph for this function:

G4bool G4XmlFileManager::CloseNtupleFile ( NtupleDescriptionType * ntupleDescription )

Definition at line 172 of file G4XmlFileManager.cc.

 {
   // Do nothing if there is no file
   if ( ! ntupleDescription->fFile ) return true;
 
   G4String ntupleName = ntupleDescription->fNtupleBooking.name();
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()
       ->Message("close", "ntuple file", GetNtupleFileName(ntupleName));
 #endif
 
   // close file
   tools::waxml::end(*(ntupleDescription->fFile));
   ntupleDescription->fFile->close(); 
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL1() ) 
     fState.GetVerboseL1()
       ->Message("close", "ntuple file", GetNtupleFileName(ntupleName));
 #endif
 
   return true; 
 } 

Here is the call graph for this function:

G4bool G4XmlFileManager::CreateHnFile ( )

Definition at line 82 of file G4XmlFileManager.cc.

 {
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()->Message("create", "histo file", GetFullFileName());
 #endif
   
   // delete a previous file if it exists
   //if ( fHnFile ) delete fHnFile; 
   
   fHnFile = std::make_shared<std::ofstream>(GetFullFileName());
   if ( fHnFile->fail() ) {
     fHnFile = nullptr;
     G4ExceptionDescription description;
     description << "      " << "Cannot open file " << GetFullFileName();
     G4Exception("G4XmlFileManager::CreateHnFile()",
               "Analysis_W001", JustWarning, description);
     return false;
   }
 
   tools::waxml::begin(*fHnFile);
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL1() ) 
     fState.GetVerboseL1()->Message("create", "histo file", GetFullFileName());
 #endif
 
   return true;
 }  

Here is the call graph for this function:

G4bool G4XmlFileManager::CreateNtupleFile ( NtupleDescriptionType * ntupleDescription )

Definition at line 137 of file G4XmlFileManager.cc.

 {
   G4String ntupleName = ntupleDescription->fNtupleBooking.name();
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL4() ) 
     fState.GetVerboseL4()
       ->Message("create", "ntuple file", GetNtupleFileName(ntupleName));
 #endif
 
   auto ntupleFile = new std::ofstream(GetNtupleFileName(ntupleName));
   if ( ntupleFile->fail() ) {
     delete ntupleFile;
     G4ExceptionDescription description;
     description << "      " << "Cannot open file " 
                 << GetNtupleFileName(ntupleName);
     G4Exception("G4XmlFileManager::CreateNtupleFile()",
                 "Analysis_W001", JustWarning, description);
     return false;
   }
   
   tools::waxml::begin(*ntupleFile);
   ntupleDescription->fFile = ntupleFile;
 
 #ifdef G4VERBOSE
   if ( fState.GetVerboseL1() ) 
     fState.GetVerboseL1()
       ->Message("create", "ntuple file", GetNtupleFileName(ntupleName));
 #endif
 
   return true;
 }  

Here is the call graph for this function:

std::shared_ptr< std::ofstream > G4XmlFileManager::GetHnFile ( ) const

inline

Definition at line 77 of file G4XmlFileManager.hh.

78 { return fHnFile; }

G4bool G4XmlFileManager::OpenFile ( const G4String & fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 54 of file G4XmlFileManager.cc.

 {
   // Keep and locks file name
   fFileName =  fileName;
   fLockFileName = true;
   fIsOpenFile = true;
 
   return true;
 }  

G4bool G4XmlFileManager::WriteFile ( )

finalvirtual

Implements G4VFileManager.

Definition at line 65 of file G4XmlFileManager.cc.

 {
   // Nothing to be done here
   return true;
 }

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

source/geant4.10.03.p02/source/analysis/xml/include/G4XmlFileManager.hh
source/geant4.10.03.p02/source/analysis/xml/src/G4XmlFileManager.cc

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation