#include <G4RootFileManager.hh>

Inheritance diagram for G4RootFileManager:

Public Member Functions
	G4RootFileManager (const G4AnalysisManagerState &state)

	G4RootFileManager ()=delete

	~G4RootFileManager () override=default

G4bool	OpenFile (const G4String &fileName) final

G4String	GetFileType () const final

G4bool	HasCycles () const final

std::shared_ptr< G4RootFile >	CreateNtupleFile (RootNtupleDescription *ntupleDescription, G4int mainNumber=-1)

std::shared_ptr< G4RootFile >	GetNtupleFile (RootNtupleDescription *ntupleDescription, G4bool perThread=true, G4int mainNumber=-1) const

G4bool	CloseNtupleFile (RootNtupleDescription *ntupleDescription, G4int mainNumber=-1)

void	SetBasketSize (unsigned int basketSize)

void	SetBasketEntries (unsigned int basketEntries)

unsigned int	GetBasketSize () const

unsigned int	GetBasketEntries () const

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

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

Public Member Functions inherited from G4VTFileManager< G4RootFile >
	G4VTFileManager (const G4AnalysisManagerState &state)

	~G4VTFileManager () override=default

G4bool	CreateFile (const G4String &fileName) final

G4bool	WriteFile (const G4String &fileName) final

virtual G4bool	WriteFile (const G4String &fileName)=0

G4bool	CloseFile (const G4String &fileName) final

virtual G4bool	CloseFile (const G4String &fileName)=0

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< G4RootFile >	GetFile () const

Public Member Functions inherited from G4VFileManager
	G4VFileManager (const G4AnalysisManagerState &state)

	G4VFileManager ()=delete

	~G4VFileManager () override=default

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	OpenFiles ()=0

virtual G4bool	WriteFiles ()=0

virtual G4bool	CloseFiles ()=0

virtual G4bool	DeleteEmptyFiles ()=0

virtual void	Clear ()=0

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

virtual G4bool	SetFileName (const G4String &fileName)

virtual G4String	GetFileType () const

virtual G4bool	HasCycles () 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	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< FT >
	G4TFileManager (const G4AnalysisManagerState &state)

	G4TFileManager ()=delete

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 ()

void	ClearData ()

Protected Member Functions
std::shared_ptr< G4RootFile >	CreateFileImpl (const G4String &fileName) final

G4bool	WriteFileImpl (std::shared_ptr< G4RootFile > file) final

G4bool	CloseFileImpl (std::shared_ptr< G4RootFile > 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

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< G4RootFile >
std::shared_ptr< G4RootFile >	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

G4String	fFileName

std::vector< G4String >	fFileNames

Static Protected Attributes inherited from G4VFileManager
static constexpr std::string_view	fkClass { "G4VFileManager" }

Detailed Description

Definition at line 53 of file G4RootFileManager.hh.

Constructor & Destructor Documentation

◆ G4RootFileManager() [1/2]

G4RootFileManager::G4RootFileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 42 of file G4RootFileManager.cc.

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

◆ G4RootFileManager() [2/2]

G4RootFileManager::G4RootFileManager ( )

delete

◆ ~G4RootFileManager()

G4RootFileManager::~G4RootFileManager ( )

overridedefault

Member Function Documentation

◆ CloseFileImpl()

G4bool G4RootFileManager::CloseFileImpl ( std::shared_ptr< G4RootFile > file )

finalprotected

Definition at line 158 of file G4RootFileManager.cc.

{
// New prototype: called by G4TFileManager base classe
 
  if (file == nullptr) return false;
 
  // write file (only once)
  unsigned int n;
  std::get<0>(*file)->write(n);
 
  // close file
  std::get<0>(*file)->close();
 
  return true;
}

◆ CloseNtupleFile()

G4bool G4RootFileManager::CloseNtupleFile	(	RootNtupleDescription *	ntupleDescription,
		G4int	mainNumber = `-1`
	)

Definition at line 237 of file G4RootFileManager.cc.

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

◆ CreateFileImpl()

std::shared_ptr< G4RootFile > G4RootFileManager::CreateFileImpl ( const G4String & fileName )

finalprotectedvirtual

Implements G4TFileManager< FT >.

Definition at line 116 of file G4RootFileManager.cc.

{
  // create file
  std::shared_ptr<wroot::file> file = std::make_shared<wroot::file>(G4cout, fileName);
  file->add_ziper('Z',toolx::compress_buffer);
  file->set_compression(fState.GetCompressionLevel());
 
  if ( ! file->is_open() ) {
    Warn("Cannot create file " + fileName, fkClass, "CreateFileImpl");
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  // create histo directory
  tools::wroot::directory* hdirectory
    = CreateDirectory(file.get(), fHistoDirectoryName, "histograms");
  if (hdirectory == nullptr) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  // create ntuple directory
  tools::wroot::directory* ndirectory
    = CreateDirectory(file.get(), fNtupleDirectoryName, "ntuples");
  if (ndirectory == nullptr) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  return std::make_shared<G4RootFile>(file, hdirectory, ndirectory);
}

◆ CreateNtupleFile()

std::shared_ptr< G4RootFile > G4RootFileManager::CreateNtupleFile	(	RootNtupleDescription *	ntupleDescription,
		G4int	mainNumber = `-1`
	)

Definition at line 205 of file G4RootFileManager.cc.

{
  // get ntuple file name per object
  auto perThread = true;
  auto ntupleFileName = GetNtupleFileName(ntupleDescription, perThread, mainNumber);
 
  auto file = GetTFile(ntupleFileName, false);
  if (! file) {
    file = CreateTFile(ntupleFileName);
  }
 
  // register file in ntuple description only if it is not main ntuple file
  // (main ntuple files are managed in main ntuple manager)
  if ( mainNumber == -1 ) {
    ntupleDescription->SetFile(file);
  }
 
  return file;
}

◆ GetBasketEntries()

unsigned int G4RootFileManager::GetBasketEntries ( ) const

inline

Definition at line 127 of file G4RootFileManager.hh.

128{ return fBasketEntries; }

◆ GetBasketSize()

unsigned int G4RootFileManager::GetBasketSize ( ) const

inline

Definition at line 123 of file G4RootFileManager.hh.

124{ return fBasketSize; }

◆ GetFileType()

G4String G4RootFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 67 of file G4RootFileManager.hh.

67{ return "root"; }

◆ GetNtupleFile()

std::shared_ptr< G4RootFile > G4RootFileManager::GetNtupleFile	(	RootNtupleDescription *	ntupleDescription,
		G4bool	perThread = `true`,
		G4int	mainNumber = `-1`
	)		const

Definition at line 227 of file G4RootFileManager.cc.

{
  // get ntuple file name per object
  auto ntupleFileName = GetNtupleFileName(ntupleDescription, perThread, mainNumber);
 
  return GetTFile(ntupleFileName, false);
}

◆ GetNtupleFileName() [1/2]

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

Definition at line 80 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 88 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);
}

◆ HasCycles()

G4bool G4RootFileManager::HasCycles ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 68 of file G4RootFileManager.hh.

68{ return true; }

◆ OpenFile()

G4bool G4RootFileManager::OpenFile ( const G4String & fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 178 of file G4RootFileManager.cc.

{
// Open default file
 
  // Keep file name
  fFileName =  fileName;
  auto name = GetFullFileName();
 
  if ( fFile ) {
    Warn("File " + fileName + " already exists.", fkClass, "OpenFile");
    fFile.reset();
  }
 
  // Create file (and save in in the file map)
  fFile = CreateTFile(name);
  if ( ! fFile ) {
    Warn("Failed to create file " + fileName, fkClass, "OpenFile");
    return false;
  }
 
  LockDirectoryNames();
  fIsOpenFile = true;
 
  return true;
}

◆ SetBasketEntries()

void G4RootFileManager::SetBasketEntries ( unsigned int basketEntries )

inline

Definition at line 119 of file G4RootFileManager.hh.

120{ fBasketEntries = basketEntries; }

◆ SetBasketSize()

void G4RootFileManager::SetBasketSize ( unsigned int basketSize )

inline

Definition at line 115 of file G4RootFileManager.hh.

116{ fBasketSize = basketSize; }

◆ WriteFileImpl()

G4bool G4RootFileManager::WriteFileImpl ( std::shared_ptr< G4RootFile > file )

finalprotected

Definition at line 148 of file G4RootFileManager.cc.

{
// New prototype: called by G4TFileManager base classe
 
  // nothing to be done, but file should exist
  return (file == nullptr) ? false : true;
 
}

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4RootFileManager() [1/2]

◆ G4RootFileManager() [2/2]

◆ ~G4RootFileManager()

Member Function Documentation

◆ CloseFileImpl()

◆ CloseNtupleFile()

◆ CreateFileImpl()

◆ CreateNtupleFile()

◆ GetBasketEntries()

◆ GetBasketSize()

◆ GetFileType()

◆ GetNtupleFile()

◆ GetNtupleFileName() [1/2]

◆ GetNtupleFileName() [2/2]

◆ HasCycles()

◆ OpenFile()

◆ SetBasketEntries()

◆ SetBasketSize()

◆ WriteFileImpl()