G4XmlFileManager Class Reference

#include <G4XmlFileManager.hh>

Inheritance diagram for G4XmlFileManager:

Public Member Functions
	G4XmlFileManager (const G4AnalysisManagerState &state)
	~G4XmlFileManager ()
virtual G4bool	OpenFile (const G4String &fileName) final
virtual G4String	GetFileType () const final
G4bool	CreateNtupleFile (XmlNtupleDescription *ntupleDescription)
G4bool	CloseNtupleFile (XmlNtupleDescription *ntupleDescription)
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
Public Member Functions inherited from G4VTFileManager< std::ofstream >
	G4VTFileManager (const G4AnalysisManagerState &state)
	~G4VTFileManager ()
virtual G4bool	CreateFile (const G4String &fileName) final
virtual G4bool	WriteFile (const G4String &fileName) final
virtual G4bool	WriteFile (const G4String &fileName)=0
virtual G4bool	CloseFile (const G4String &fileName) final
virtual G4bool	CloseFile (const G4String &fileName)=0
virtual G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty) final
virtual G4bool	WriteFiles () final
virtual G4bool	CloseFiles () final
virtual G4bool	DeleteEmptyFiles () final
std::shared_ptr< std::ofstream >	GetFile () const
Public Member Functions inherited from G4VFileManager
	G4VFileManager (const G4AnalysisManagerState &state)
virtual	~G4VFileManager ()
virtual G4bool	OpenFile (const G4String &fileName)=0
virtual G4bool	CreateFile (const G4String &fileName)=0
virtual G4bool	WriteFile (const G4String &fileName)=0
virtual G4bool	CloseFile (const G4String &fileName)=0
virtual G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)=0
virtual G4bool	WriteFiles ()=0
virtual G4bool	CloseFiles ()=0
virtual G4bool	DeleteEmptyFiles ()=0
virtual G4bool	SetFileName (const G4String &fileName) final
G4bool	SetHistoDirectoryName (const G4String &dirName)
G4bool	SetNtupleDirectoryName (const G4String &dirName)
void	LockDirectoryNames ()
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
template<typename HT >
std::shared_ptr< G4VTHnFileManager< HT > >	GetHnFileManager () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
virtual	~G4BaseFileManager ()
virtual G4bool	SetFileName (const G4String &fileName)
virtual G4String	GetFileType () const
void	AddFileName (const G4String &fileName)
G4String	GetFileName () const
G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
const std::vector< G4String > &	GetFileNames () const
G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
Public Member Functions inherited from G4TFileManager< FT >
	G4TFileManager (const G4AnalysisManagerState &state)
virtual	~G4TFileManager ()
std::shared_ptr< FT >	CreateTFile (const G4String &fileName)
G4bool	WriteTFile (const G4String &fileName)
G4bool	CloseTFile (const G4String &fileName)
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)
std::shared_ptr< FT >	GetTFile (const G4String &fileName, G4bool warn=true) const
G4bool	OpenFiles ()
G4bool	WriteFiles ()
G4bool	CloseFiles ()
G4bool	DeleteEmptyFiles ()

Protected Member Functions
virtual std::shared_ptr< std::ofstream >	CreateFileImpl (const G4String &fileName) final
virtual G4bool	WriteFileImpl (std::shared_ptr< std::ofstream > file) final
virtual G4bool	CloseFileImpl (std::shared_ptr< std::ofstream > file) final
Protected Member Functions inherited from G4TFileManager< FT >
virtual std::shared_ptr< FT >	CreateFileImpl (const G4String &fileName)=0
virtual G4bool	WriteFileImpl (std::shared_ptr< FT > file)=0
virtual G4bool	CloseFileImpl (std::shared_ptr< FT > file)=0

Additional Inherited Members
Protected Attributes inherited from G4VTFileManager< std::ofstream >
std::shared_ptr< std::ofstream >	fFile
Protected Attributes inherited from G4VFileManager
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fIsOpenFile
G4bool	fLockDirectoryNames
std::shared_ptr< G4VTHnFileManager< tools::histo::h1d > >	fH1FileManager
std::shared_ptr< G4VTHnFileManager< tools::histo::h2d > >	fH2FileManager
std::shared_ptr< G4VTHnFileManager< tools::histo::h3d > >	fH3FileManager
std::shared_ptr< G4VTHnFileManager< tools::histo::p1d > >	fP1FileManager
std::shared_ptr< G4VTHnFileManager< tools::histo::p2d > >	fP2FileManager
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4String	fFileName
std::vector< G4String >	fFileNames

Detailed Description

Definition at line 49 of file G4XmlFileManager.hh.

Constructor & Destructor Documentation

G4XmlFileManager()

G4XmlFileManager::G4XmlFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 40 of file G4XmlFileManager.cc.

 : G4VTFileManager<std::ofstream>(state)
{
  // Create helpers defined in the base class
  fH1FileManager = std::make_shared<G4XmlHnFileManager<histo::h1d>>(this);
  fH2FileManager = std::make_shared<G4XmlHnFileManager<histo::h2d>>(this);
  fH3FileManager = std::make_shared<G4XmlHnFileManager<histo::h3d>>(this);
  fP1FileManager = std::make_shared<G4XmlHnFileManager<histo::p1d>>(this);
  fP2FileManager = std::make_shared<G4XmlHnFileManager<histo::p2d>>(this);
}

~G4XmlFileManager()

G4XmlFileManager::~G4XmlFileManager

(

)

Definition at line 52 of file G4XmlFileManager.cc.

{}

Member Function Documentation

CloseFileImpl()

G4bool G4XmlFileManager::CloseFileImpl ( std::shared_ptr< std::ofstream >  file )

finalprotectedvirtual

Definition at line 103 of file G4XmlFileManager.cc.

{
  if ( ! file ) return false;
 
  // close file
  waxml::end(*file);
  file->close(); 
 
  return true;
}

CloseNtupleFile()

G4bool G4XmlFileManager::CloseNtupleFile

(

XmlNtupleDescription *

ntupleDescription

)

Definition at line 193 of file G4XmlFileManager.cc.

{
  // Do nothing if there is no file
  if ( ! ntupleDescription->fFile ) return true;
 
  auto finalResult = true;
 
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    fState.GetVerboseL4()->Message("close", "ntuple file", ntupleFileName);
  }
#endif
 
  // close file
  auto result = CloseTFile(ntupleFileName);
  finalResult = result && finalResult;
 
  // Notify not empty file
  result = SetIsEmpty(ntupleFileName, ! ntupleDescription->fHasFill);
  finalResult = result && finalResult;
 
  // Reset file info in ntuple description
  ntupleDescription->fFile.reset();
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    fState.GetVerboseL2()->Message("close", "ntuple file", ntupleFileName);
  }
#endif
 
  return result; 
}

CreateFileImpl()

std::shared_ptr< std::ofstream > G4XmlFileManager::CreateFileImpl ( const G4String &  fileName )

finalprotectedvirtual

Implements G4TFileManager< FT >.

Definition at line 79 of file G4XmlFileManager.cc.

{
  std::shared_ptr<std::ofstream> file = std::make_shared<std::ofstream>(fileName);
  if ( file->fail() ) {
    file = nullptr;
    G4ExceptionDescription description;
    description << "      " << "Cannot create file " << fileName;
    G4Exception("G4XmlFileManager::CreateFileImpl()",
              "Analysis_W001", JustWarning, description);
    return nullptr;
  }
 
  waxml::begin(*file);
  return file;
}

CreateNtupleFile()

G4bool G4XmlFileManager::CreateNtupleFile

(

XmlNtupleDescription *

ntupleDescription

)

Definition at line 152 of file G4XmlFileManager.cc.

{
  // get ntuple file name per object (if defined)
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    fState.GetVerboseL4()->Message("create", "ntuple file", ntupleFileName);
  }
#endif
 
  // update file name if it is already in use
  while ( GetTFile(ntupleFileName, false) ) {
    // the file is already in use
    auto oldName = ntupleDescription->fFileName;
    auto newName = GetBaseName(oldName) + "_bis." + GetExtension(oldName);
    ntupleDescription->fFileName = newName;
 
    G4ExceptionDescription description;
    description
      << "Ntuple filename " << oldName << " is already in use." << G4endl
      << "It will be replaced with : " << newName;
    G4Exception("G4XmlFileManager::CreateFileImpl()",
                "Analysis_W001", JustWarning, description);
 
    ntupleFileName = GetNtupleFileName(ntupleDescription);
  }
 
  ntupleDescription->fFile = CreateTFile(ntupleFileName);
 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    fState.GetVerboseL2()->Message("create", "ntuple file", ntupleFileName);
  }
#endif
 
  return (ntupleDescription->fFile != nullptr);
}  

GetFileType()

virtual G4String G4XmlFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 62 of file G4XmlFileManager.hh.

{ return "xml"; }

GetNtupleFileName() [1/2]

G4String G4BaseFileManager::GetNtupleFileName

(

const G4String &

ntupleName

)

const

Definition at line 70 of file G4BaseFileManager.cc.

{  
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleName);
}  

GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName

(

G4int

ntupleFileNumber

)

const

Definition at line 76 of file G4BaseFileManager.cc.

{  
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleFileNumber);
}  

OpenFile()

G4bool G4XmlFileManager::OpenFile ( const G4String &  fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 119 of file G4XmlFileManager.cc.

{
  // Keep and locks file name
  fFileName =  fileName;
  auto name = GetFullFileName(fFileName);
 
  if ( fFile ) {
    G4ExceptionDescription description;
    description << "File " << fileName << " already exists.";
    G4Exception("G4XmlFileManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    fFile.reset();
  }
 
  // Create histograms file (on master)
  if ( fState.GetIsMaster() ) {
    // Create file (and save in in the file map (on master only)
    fFile = CreateTFile(name);
    if ( ! fFile) {
      G4ExceptionDescription description;
      description << "Failed to create file " << fileName;
      G4Exception("G4XmlFileManager::OpenFile()",
                  "Analysis_W001", JustWarning, description);
      return false;
    }
  }
 
  fIsOpenFile = true;
 
  return true;
}  

WriteFileImpl()

G4bool G4XmlFileManager::WriteFileImpl ( std::shared_ptr< std::ofstream >  file )

finalprotectedvirtual

Definition at line 96 of file G4XmlFileManager.cc.

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

---

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

• G4XmlFileManager.hh
• G4XmlFileManager.cc