G4XmlFileManager Class Reference

#include <G4XmlFileManager.hh>

Inheritance diagram for G4XmlFileManager:

Public Member Functions
	G4XmlFileManager (const G4AnalysisManagerState &state)
	G4XmlFileManager ()=delete
	~G4XmlFileManager () override=default
G4bool	OpenFile (const G4String &fileName) final
G4String	GetFileType () const final
G4bool	CreateNtupleFile (XmlNtupleDescription *ntupleDescription)
G4bool	CloseNtupleFile (XmlNtupleDescription *ntupleDescription)
G4String	GetNtupleFileName (const G4String &ntupleName, G4int cycle=0) const
G4String	GetNtupleFileName (G4int ntupleFileNumber, G4int cycle=0) const
Public Member Functions inherited from G4VTFileManager< std::ofstream >
	G4VTFileManager (const G4AnalysisManagerState &state)
	~G4VTFileManager () override=default
G4bool	CreateFile (const G4String &fileName) final
G4bool	WriteFile (const G4String &fileName) final
G4bool	CloseFile (const G4String &fileName) final
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty) final
G4bool	OpenFiles () final
G4bool	WriteFiles () final
G4bool	CloseFiles () final
G4bool	DeleteEmptyFiles () final
void	Clear () final
std::shared_ptr< std::ofstream >	GetFile () const
Public Member Functions inherited from G4VFileManager
	G4VFileManager (const G4AnalysisManagerState &state)
	G4VFileManager ()=delete
	~G4VFileManager () override=default
G4bool	SetFileName (const G4String &fileName) final
virtual G4bool	SetHistoDirectoryName (const G4String &dirName)
virtual G4bool	SetNtupleDirectoryName (const G4String &dirName)
void	LockDirectoryNames ()
void	UnlockDirectoryNames ()
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
G4int	GetCycle () const
template<typename HT >
std::shared_ptr< G4VTHnFileManager< HT > >	GetHnFileManager () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
	G4BaseFileManager ()=delete
virtual	~G4BaseFileManager ()=default
void	SetCompressionLevel (G4int level)
virtual G4bool	HasCycles () const
void	AddFileName (const G4String &fileName)
G4int	GetCompressionLevel () const
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	GetHnFileName (const G4String &fileName, G4int cycle=0) const
G4String	GetNtupleFileName (const G4String &ntupleName, G4int cycle=0) const
G4String	GetNtupleFileName (G4int ntupleFileNumber, G4int cycle=0) const
G4String	GetPlotFileName () const
Public Member Functions inherited from G4TFileManager< std::ofstream >
	G4TFileManager (const G4AnalysisManagerState &state)
	G4TFileManager ()=delete
virtual	~G4TFileManager ()
std::shared_ptr< std::ofstream >	CreateTFile (const G4String &fileName)
G4bool	WriteTFile (const G4String &fileName)
G4bool	CloseTFile (const G4String &fileName)
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)
std::shared_ptr< std::ofstream >	GetTFile (const G4String &fileName, G4bool warn=true) const
G4bool	OpenFiles ()
G4bool	WriteFiles ()
G4bool	CloseFiles ()
G4bool	DeleteEmptyFiles ()
void	ClearData ()

Protected Member Functions
std::shared_ptr< std::ofstream >	CreateFileImpl (const G4String &fileName) final
G4bool	WriteFileImpl (std::shared_ptr< std::ofstream > file) final
G4bool	CloseFileImpl (std::shared_ptr< std::ofstream > file) final
Protected Member Functions inherited from G4BaseFileManager
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
void	ClearData ()
Protected Member Functions inherited from G4TFileManager< std::ofstream >

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 { false }
G4bool	fLockDirectoryNames { false }
std::shared_ptr< G4VTHnFileManager< tools::histo::h1d > >	fH1FileManager { nullptr }
std::shared_ptr< G4VTHnFileManager< tools::histo::h2d > >	fH2FileManager { nullptr }
std::shared_ptr< G4VTHnFileManager< tools::histo::h3d > >	fH3FileManager { nullptr }
std::shared_ptr< G4VTHnFileManager< tools::histo::p1d > >	fP1FileManager { nullptr }
std::shared_ptr< G4VTHnFileManager< tools::histo::p2d > >	fP2FileManager { nullptr }
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4int	fCompressionLevel { 1 }
G4String	fFileName
std::vector< G4String >	fFileNames
Static Protected Attributes inherited from G4VFileManager
static constexpr std::string_view	fkClass { "G4VFileManager" }

Detailed Description

Definition at line 50 of file G4XmlFileManager.hh.

Constructor & Destructor Documentation

G4XmlFileManager() [1/2]

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() [2/2]

G4XmlFileManager::G4XmlFileManager ( )

delete

~G4XmlFileManager()

G4XmlFileManager::~G4XmlFileManager ( )

overridedefault

Member Function Documentation

CloseFileImpl()

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

finalprotectedvirtual

Implements G4TFileManager< std::ofstream >.

Definition at line 99 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 160 of file G4XmlFileManager.cc.

{
  // Notify not empty file
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
  auto result = SetIsEmpty(ntupleFileName, ! ntupleDescription->GetHasFill());
 
  // Ntuple files are registered in file manager map.
  // they will be closed with CloseFiles() calls
  ntupleDescription->GetFile().reset();
 
  return result;
}

CreateFileImpl()

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

finalprotectedvirtual

Implements G4TFileManager< std::ofstream >.

Definition at line 79 of file G4XmlFileManager.cc.

{
  std::shared_ptr<std::ofstream> file = std::make_shared<std::ofstream>(fileName);
  if ( file->fail() ) {
    Warn(G4String("Cannot create file ") + fileName, fkClass, "CreateFileImpl");
    return nullptr;
  }
 
  waxml::begin(*file);
  return file;
}

CreateNtupleFile()

G4bool G4XmlFileManager::CreateNtupleFile

(

XmlNtupleDescription *

ntupleDescription

)

Definition at line 142 of file G4XmlFileManager.cc.

{
  // Get ntuple file name per object (if defined)
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
  // Create ntuple file name if it does not yet exist
  auto ntupleFile = GetTFile(ntupleFileName, false);
  if ( ntupleFile == nullptr) {
    ntupleFile = CreateTFile(ntupleFileName);
  }
 
  ntupleDescription->SetFile(ntupleFile);
 
  return (ntupleDescription->GetFile() != nullptr);
}

GetFileType()

G4String G4XmlFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 64 of file G4XmlFileManager.hh.

{ return "xml"; }

GetNtupleFileName() [1/2]

G4String G4BaseFileManager::GetNtupleFileName	(	const G4String &	ntupleName,
		G4int	cycle = 0 ) const

Definition at line 84 of file G4BaseFileManager.cc.

{
  // Do not pass cycle if supported by the output type
  auto cycleToPass = (HasCycles()) ? 0 : cycle;
 
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleName, cycleToPass);
}

GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName	(	G4int	ntupleFileNumber,
		G4int	cycle = 0 ) const

Definition at line 92 of file G4BaseFileManager.cc.

{
  // Do not pass cycle if supported by the output type
  auto cycleToPass = (HasCycles()) ? 0 : cycle;
 
  return G4Analysis::GetNtupleFileName(fFileName, GetFileType(), ntupleFileNumber, cycleToPass);
}

OpenFile()

G4bool G4XmlFileManager::OpenFile ( const G4String & fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 115 of file G4XmlFileManager.cc.

{
  // Keep and locks file name
  fFileName =  fileName;
  auto name = GetFullFileName(fFileName);
 
  if ( fFile ) {
    Warn(G4String("File ") + fileName + " already exists.", fkClass, "OpenFile");
    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) {
      Warn(G4String("Failed to create file") + fileName, fkClass, "OpenFile");
      return false;
    }
  }
 
  fIsOpenFile = true;
 
  return true;
}

WriteFileImpl()

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

finalprotectedvirtual

Implements G4TFileManager< std::ofstream >.

Definition at line 92 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