G4Hdf5FileManager Class Reference

#include <G4Hdf5FileManager.hh>

Inheritance diagram for G4Hdf5FileManager:

Public Member Functions
	G4Hdf5FileManager (const G4AnalysisManagerState &state)
	G4Hdf5FileManager ()=delete
	~G4Hdf5FileManager () override=default
G4bool	OpenFile (const G4String &fileName) final
G4String	GetFileType () const final
G4bool	CreateNtupleFile (Hdf5NtupleDescription *ntupleDescription)
G4bool	CloseNtupleFile (Hdf5NtupleDescription *ntupleDescription)
void	SetBasketSize (unsigned int basketSize)
hid_t	GetHistoDirectory () const
hid_t	GetNtupleDirectory () const
unsigned int	GetBasketSize () const
G4String	GetNtupleFileName (const G4String &ntupleName, G4int cycle=0) const
G4String	GetNtupleFileName (G4int ntupleFileNumber, G4int cycle=0) const
Public Member Functions inherited from G4VTFileManager< G4Hdf5File >
	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< G4Hdf5File >	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
virtual 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< G4Hdf5File >
	G4TFileManager (const G4AnalysisManagerState &state)
virtual	~G4TFileManager ()
std::shared_ptr< G4Hdf5File >	CreateTFile (const G4String &fileName)
G4bool	WriteTFile (const G4String &fileName)
G4bool	CloseTFile (const G4String &fileName)
G4bool	SetIsEmpty (const G4String &fileName, G4bool isEmpty)
std::shared_ptr< G4Hdf5File >	GetTFile (const G4String &fileName, G4bool warn=true) const
G4bool	OpenFiles ()
G4bool	WriteFiles ()
G4bool	CloseFiles ()
G4bool	DeleteEmptyFiles ()
void	ClearData ()

Protected Member Functions
std::shared_ptr< G4Hdf5File >	CreateFileImpl (const G4String &fileName) final
G4bool	WriteFileImpl (std::shared_ptr< G4Hdf5File > file) final
G4bool	CloseFileImpl (std::shared_ptr< G4Hdf5File > 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 ()

Additional Inherited Members
Protected Attributes inherited from G4VTFileManager< G4Hdf5File >
std::shared_ptr< G4Hdf5File >	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 47 of file G4Hdf5FileManager.hh.

Constructor & Destructor Documentation

G4Hdf5FileManager() [1/2]

G4Hdf5FileManager::G4Hdf5FileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 48 of file G4Hdf5FileManager.cc.

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

G4Hdf5FileManager() [2/2]

G4Hdf5FileManager::G4Hdf5FileManager ( )

delete

~G4Hdf5FileManager()

G4Hdf5FileManager::~G4Hdf5FileManager ( )

overridedefault

Member Function Documentation

CloseFileImpl()

G4bool G4Hdf5FileManager::CloseFileImpl ( std::shared_ptr< G4Hdf5File > file )

finalprotectedvirtual

Implements G4TFileManager< G4Hdf5File >.

Definition at line 176 of file G4Hdf5FileManager.cc.

{
  if ( ! file ) return false;
 
  G4AutoLock lock(&closeFileMutex);
 
  ::H5Gclose(std::get<1>(*file));
  ::H5Gclose(std::get<2>(*file));
  ::H5Fclose(std::get<0>(*file));
 
  lock.unlock();
 
  return true;
}

CloseNtupleFile()

G4bool G4Hdf5FileManager::CloseNtupleFile

(

Hdf5NtupleDescription *

ntupleDescription

)

Definition at line 237 of file G4Hdf5FileManager.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< G4Hdf5File > G4Hdf5FileManager::CreateFileImpl ( const G4String & fileName )

finalprotectedvirtual

Implements G4TFileManager< G4Hdf5File >.

Definition at line 130 of file G4Hdf5FileManager.cc.

{
  // create a new file
  hid_t file = ::H5Fcreate(fileName, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);
 
  // Do nothing if there is no file
  // (the error should be handled by caller)
  if ( file < 0 ) {
    Warn("::H5Fcreate failed " + fileName, fkClass, "CreateFileImpl");
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  // create a header with general infos
  if(!toolx::hdf5::write_header(file)) {
    Warn("toolx::hdf5::write_header() failed for " + fileName,
      fkClass, "CreateFileImpl");
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  // create histo directory
  auto hdirectory
    = CreateDirectory(file, fHistoDirectoryName, "histograms");
  if ( hdirectory < 0 ) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  // create ntuple directory
  auto ndirectory
    = CreateDirectory(file, fNtupleDirectoryName, "ntuples");
  if ( ndirectory < 0 ) {
    // Warnin is issued in CreateDirectory
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  return std::make_shared<G4Hdf5File>(file, hdirectory, ndirectory);
}

CreateNtupleFile()

G4bool G4Hdf5FileManager::CreateNtupleFile

(

Hdf5NtupleDescription *

ntupleDescription

)

Definition at line 221 of file G4Hdf5FileManager.cc.

{
  // get ntuple file name per object
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
 
  auto file = GetTFile(ntupleFileName, false);
  if (! file) {
    file = CreateTFile(ntupleFileName);
  }
  ntupleDescription->SetFile(file);
 
  return (ntupleDescription->GetFile() != nullptr);
}

GetBasketSize()

unsigned int G4Hdf5FileManager::GetBasketSize ( ) const

inline

Definition at line 101 of file G4Hdf5FileManager.hh.

{ return fBasketSize; }

GetFileType()

G4String G4Hdf5FileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 61 of file G4Hdf5FileManager.hh.

{ return "hdf5"; }

GetHistoDirectory()

hid_t G4Hdf5FileManager::GetHistoDirectory

(

)

const

Definition at line 252 of file G4Hdf5FileManager.cc.

{
  if ( ! fFile ) return kInvalidId;
 
  return std::get<1>(*fFile);
}

GetNtupleDirectory()

hid_t G4Hdf5FileManager::GetNtupleDirectory

(

)

const

Definition at line 260 of file G4Hdf5FileManager.cc.

{
  if ( ! fFile ) return kInvalidId;
 
  return std::get<2>(*fFile);
}

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 G4Hdf5FileManager::OpenFile ( const G4String & fileName )

finalvirtual

Implements G4VFileManager.

Definition at line 196 of file G4Hdf5FileManager.cc.

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

SetBasketSize()

void G4Hdf5FileManager::SetBasketSize ( unsigned int basketSize )

inline

Definition at line 97 of file G4Hdf5FileManager.hh.

{ fBasketSize = basketSize; }

WriteFileImpl()

G4bool G4Hdf5FileManager::WriteFileImpl ( std::shared_ptr< G4Hdf5File > file )

finalprotectedvirtual

Implements G4TFileManager< G4Hdf5File >.

Definition at line 169 of file G4Hdf5FileManager.cc.

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

---

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

• G4Hdf5FileManager.hh
• G4Hdf5FileManager.cc