#include <G4Hdf5RFileManager.hh>

Inheritance diagram for G4Hdf5RFileManager:

Public Member Functions
void	AddFileName (const G4String &fileName)

virtual void	CloseFiles () final

	G4Hdf5RFileManager ()=delete

	G4Hdf5RFileManager (const G4AnalysisManagerState &state)

G4String	GetFileName () const

const std::vector< G4String > &	GetFileNames () const

virtual G4String	GetFileType () const final

G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const

hid_t	GetHistoRDirectory (const G4String &fileName, const G4String &dirName, G4bool isPerThread)

G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const

template<typename HT >
std::shared_ptr< G4VTHnRFileManager< HT > >	GetHnRFileManager () const

G4String	GetNtupleFileName (const G4String &ntupleName) const

G4String	GetNtupleFileName (G4int ntupleFileNumber) const

hid_t	GetNtupleRDirectory (const G4String &fileName, const G4String &dirName, G4bool isPerThread)

G4String	GetPlotFileName () const

G4Hdf5File *	GetRFile (const G4String &fileName, G4bool isPerThread)

virtual G4bool	SetFileName (const G4String &fileName)

virtual	~G4Hdf5RFileManager ()=default

Protected Member Functions
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Protected Attributes
G4String	fFileName

std::vector< G4String >	fFileNames

std::shared_ptr< G4VTHnRFileManager< tools::histo::h1d > >	fH1RFileManager { nullptr }

std::shared_ptr< G4VTHnRFileManager< tools::histo::h2d > >	fH2RFileManager { nullptr }

std::shared_ptr< G4VTHnRFileManager< tools::histo::h3d > >	fH3RFileManager { nullptr }

std::shared_ptr< G4VTHnRFileManager< tools::histo::p1d > >	fP1RFileManager { nullptr }

std::shared_ptr< G4VTHnRFileManager< tools::histo::p2d > >	fP2RFileManager { nullptr }

const G4AnalysisManagerState &	fState

Private Member Functions
hid_t	GetRDirectory (const G4String &directoryType, const G4String &fileName, const G4String &dirName, G4bool isPerThread)

hid_t	OpenDirectory (hid_t file, const G4String &directoryName)

hid_t	OpenRFile (const G4String &fileName, G4bool isPerThread)

Private Attributes
std::map< G4String, G4Hdf5File >	fRFiles

Static Private Attributes
static const G4String	fgkDefaultDirectoryName { "default" }

static constexpr std::string_view	fkClass { "G4Hdf5RFileManager" }

Detailed Description

Definition at line 45 of file G4Hdf5RFileManager.hh.

Constructor & Destructor Documentation

◆ G4Hdf5RFileManager() [1/2]

G4Hdf5RFileManager::G4Hdf5RFileManager ( const G4AnalysisManagerState & state )

explicit

Definition at line 42 of file G4Hdf5RFileManager.cc.

 : G4VRFileManager(state)
{
  // Create helpers defined in the base class
  fH1RFileManager = std::make_shared<G4Hdf5HnRFileManager<histo::h1d>>(this);
  fH2RFileManager = std::make_shared<G4Hdf5HnRFileManager<histo::h2d>>(this);
  fH3RFileManager = std::make_shared<G4Hdf5HnRFileManager<histo::h3d>>(this);
  fP1RFileManager = std::make_shared<G4Hdf5HnRFileManager<histo::p1d>>(this);
  fP2RFileManager = std::make_shared<G4Hdf5HnRFileManager<histo::p2d>>(this);
}

References G4VRFileManager::fH1RFileManager, G4VRFileManager::fH2RFileManager, G4VRFileManager::fH3RFileManager, G4VRFileManager::fP1RFileManager, and G4VRFileManager::fP2RFileManager.

◆ G4Hdf5RFileManager() [2/2]

G4Hdf5RFileManager::G4Hdf5RFileManager ( )

delete

◆ ~G4Hdf5RFileManager()

virtual G4Hdf5RFileManager::~G4Hdf5RFileManager ( )

virtualdefault

Member Function Documentation

◆ AddFileName()

void G4BaseFileManager::AddFileName ( const G4String & fileName )

inherited

Definition at line 44 of file G4BaseFileManager.cc.

{
  // G4cout << "registering " << fileName << " in manager of " << GetFileType() << G4endl;
 
  // Do nothing in file name is already present
  for ( const auto& name : fFileNames ) {
    if ( name == fileName ) return;
  }
 
  fFileNames.push_back(fileName);
}

References G4BaseFileManager::fFileNames, and G4InuclParticleNames::name().

◆ CloseFiles()

void G4Hdf5RFileManager::CloseFiles ( )

finalvirtual

Implements G4VRFileManager.

Definition at line 183 of file G4Hdf5RFileManager.cc.

{
  // Close all open directories and file
  for ( auto [key, rfile] : fRFiles ) {
    if (std::get<1>(rfile) != kInvalidId) {
      ::H5Gclose(std::get<1>(rfile));
    }
    if (std::get<2>(rfile) != kInvalidId) {
      ::H5Gclose(std::get<2>(rfile));
    }
    if (std::get<0>(rfile) != kInvalidId) {
      ::H5Fclose(std::get<0>(rfile));
    }
  }
}

References fRFiles, and G4Analysis::kInvalidId.

◆ GetFileName()

G4String G4BaseFileManager::GetFileName ( ) const

inlineinherited

Definition at line 105 of file G4BaseFileManager.hh.

                                                     {
  return fFileName;
}

References G4BaseFileManager::fFileName.

◆ GetFileNames()

const std::vector< G4String > & G4BaseFileManager::GetFileNames ( ) const

inlineinherited

Definition at line 109 of file G4BaseFileManager.hh.

                                                                        {
  return fFileNames;
}

References G4BaseFileManager::fFileNames.

Referenced by G4GenericFileManager::OpenFiles().

◆ GetFileType()

virtual G4String G4Hdf5RFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 52 of file G4Hdf5RFileManager.hh.

52{ return "hdf5"; }

◆ GetFullFileName()

G4String G4BaseFileManager::GetFullFileName	(	const G4String &	baseFileName = `""`,
		G4bool	isPerThread = `true`
	)		const

inherited

Definition at line 63 of file G4BaseFileManager.cc.

{
  G4String fileName(baseFileName);
  if ( fileName == "" ) fileName = fFileName;
 
  // Take out file extension
  auto name = G4Analysis::GetBaseName(fileName);
 
  // Add thread Id to a file name if MT processing
  if ( isPerThread && ! fState.GetIsMaster() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }
 
  // Add (back if it was present or is defined) file extension
  auto extension = G4Analysis::GetExtension(fileName, GetFileType());
  if ( extension.size() ) {
    name.append(".");
    name.append(extension);
  }
 
  return name;
}

References G4BaseFileManager::fFileName, G4Analysis::GetBaseName(), and G4InuclParticleNames::name().

Referenced by G4Hdf5FileManager::GetNtupleFileName(), G4RootFileManager::GetNtupleFileName(), G4XmlRFileManager::GetRFile(), GetRFile(), G4RootRFileManager::GetRFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), G4XmlFileManager::OpenFile(), G4XmlRFileManager::OpenRFile(), OpenRFile(), and G4RootRFileManager::OpenRFile().

◆ GetHistoRDirectory()

hid_t G4Hdf5RFileManager::GetHistoRDirectory	(	const G4String &	fileName,
		const G4String &	dirName,
		G4bool	isPerThread
	)

Definition at line 169 of file G4Hdf5RFileManager.cc.

{
  return GetRDirectory("histograms", fileName, dirName, isPerThread);
}

References GetRDirectory().

◆ GetHnFileName()

G4String G4BaseFileManager::GetHnFileName	(	const G4String &	hnType,
		const G4String &	hnName
	)		const

inherited

Definition at line 91 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetHnFileName(fFileName, GetFileType(), hnType, hnName);
}

References G4BaseFileManager::fFileName, G4BaseFileManager::GetFileType(), and G4Analysis::GetHnFileName().

◆ GetHnRFileManager()

template<typename HT >

std::shared_ptr< G4VTHnRFileManager< HT > > G4VRFileManager::GetHnRFileManager ( ) const

inherited

◆ GetNtupleFileName() [1/2]

G4String G4BaseFileManager::GetNtupleFileName ( const G4String & ntupleName ) const

inherited

Definition at line 98 of file G4BaseFileManager.cc.

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

References G4BaseFileManager::fFileName, G4BaseFileManager::GetFileType(), and G4Analysis::GetNtupleFileName().

◆ GetNtupleFileName() [2/2]

G4String G4BaseFileManager::GetNtupleFileName ( G4int ntupleFileNumber ) const

inherited

Definition at line 104 of file G4BaseFileManager.cc.

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

References G4BaseFileManager::fFileName, G4BaseFileManager::GetFileType(), and G4Analysis::GetNtupleFileName().

◆ GetNtupleRDirectory()

hid_t G4Hdf5RFileManager::GetNtupleRDirectory	(	const G4String &	fileName,
		const G4String &	dirName,
		G4bool	isPerThread
	)

Definition at line 176 of file G4Hdf5RFileManager.cc.

{
  return GetRDirectory("ntuples", fileName, dirName, isPerThread);
}

References GetRDirectory().

◆ GetPlotFileName()

G4String G4BaseFileManager::GetPlotFileName ( ) const

inherited

Definition at line 110 of file G4BaseFileManager.cc.

{
  return G4Analysis::GetPlotFileName(fFileName);
}

References G4BaseFileManager::fFileName, and G4Analysis::GetPlotFileName().

◆ GetRDirectory()

hid_t G4Hdf5RFileManager::GetRDirectory	(	const G4String &	directoryType,
		const G4String &	fileName,
		const G4String &	dirName,
		G4bool	isPerThread
	)

private

Definition at line 100 of file G4Hdf5RFileManager.cc.

{
  // Get or open a file
  auto rfile = GetRFile(fileName, isPerThread);
  if ( ! rfile ) {
    // Try to open it if not found in the map
    if ( OpenRFile(fileName, isPerThread) < 0 ) return kInvalidId;
    rfile = GetRFile(fileName, isPerThread);
  }
 
  auto isHistograms = (directoryType == "histograms");
 
  // Get directory if already open
  hid_t directory = kInvalidId;
  if ( isHistograms ) {
    directory = std::get<1>(*rfile);
  } else {
    directory = std::get<2>(*rfile);
  }
  if ( directory != kInvalidId ) {
    return directory;
  }
 
  // Use default directory name if not specified
  auto newDirName = dirName;
  if ( newDirName == "" ) {
      // Create the default directory if the name is not set and the default directory
      // does not yet exist
      newDirName = fgkDefaultDirectoryName;
      newDirName += "_";
      newDirName += directoryType;
  }
 
  // Open directory
  directory = OpenDirectory(std::get<0>(*rfile), newDirName);
 
  // Update
  if ( isHistograms ) {
    std::get<1>(*rfile) = directory;
  } else {
    std::get<2>(*rfile) = directory;
  }
 
  return directory;
}

References fgkDefaultDirectoryName, GetRFile(), G4Analysis::kInvalidId, OpenDirectory(), and OpenRFile().

Referenced by GetHistoRDirectory(), and GetNtupleRDirectory().

◆ GetRFile()

G4Hdf5File * G4Hdf5RFileManager::GetRFile	(	const G4String &	fileName,
		G4bool	isPerThread
	)

Definition at line 154 of file G4Hdf5RFileManager.cc.

{
  // Get full file name
  G4String name = GetFullFileName(fileName, isPerThread);
 
  auto it = fRFiles.find(name);
  if  ( it != fRFiles.end() )
    return &(it->second);
  else {
    return nullptr;
  }
}

References fRFiles, G4BaseFileManager::GetFullFileName(), and G4InuclParticleNames::name().

Referenced by GetRDirectory().

◆ Message()

void G4BaseFileManager::Message	(	G4int	level,
		const G4String &	action,
		const G4String &	objectType,
		const G4String &	objectName = `""`,
		G4bool	success = `true`
	)		const

inlineprotectedinherited

Definition at line 113 of file G4BaseFileManager.hh.

{
  fState.Message(level, action, objectType, objectName, success);
}

References geant4_check_module_cycles::action, G4BaseFileManager::fState, and G4AnalysisManagerState::Message().

Referenced by G4GenericFileManager::CloseFiles(), G4CsvFileManager::CloseNtupleFile(), G4XmlFileManager::CloseNtupleFile(), G4Hdf5FileManager::CreateDirectory(), G4RootFileManager::CreateDirectory(), G4GenericFileManager::CreateFileManager(), G4CsvFileManager::CreateNtupleFile(), G4XmlFileManager::CreateNtupleFile(), G4GenericFileManager::DeleteEmptyFiles(), OpenDirectory(), G4GenericFileManager::OpenFile(), G4GenericFileManager::OpenFiles(), G4CsvRFileManager::OpenRFile(), G4XmlRFileManager::OpenRFile(), OpenRFile(), G4RootRFileManager::OpenRFile(), and G4GenericFileManager::WriteFiles().

◆ OpenDirectory()

hid_t G4Hdf5RFileManager::OpenDirectory	(	hid_t	file,
		const G4String &	directoryName
	)

private

Definition at line 84 of file G4Hdf5RFileManager.cc.

{
  Message(kVL4, "open", "read directory", directoryName);
 
  auto directory = tools_H5Gopen(file, directoryName);
  if ( directory < 0 ) {
    Warn("Cannot open directory " + directoryName, fkClass, "OpenDirectory");
    return kInvalidId;
  }
  else {
    Message(kVL2, "open", "read directory", directoryName);
    return directory;
  }
}

References geant4_check_module_cycles::file, fkClass, G4Analysis::kInvalidId, G4Analysis::kVL2, G4Analysis::kVL4, G4BaseFileManager::Message(), and G4Analysis::Warn().

Referenced by GetRDirectory().

◆ OpenRFile()

hid_t G4Hdf5RFileManager::OpenRFile	(	const G4String &	fileName,
		G4bool	isPerThread
	)

private

Definition at line 58 of file G4Hdf5RFileManager.cc.

{
  // Get full file name
  G4String name = GetFullFileName(fileName, isPerThread);
 
  Message(kVL4, "open", "read analysis file", name);
 
  // create new file
  hid_t newFile = H5Fopen(name, H5F_ACC_RDONLY, H5P_DEFAULT);
  if ( newFile < 0 ) {
    Warn("Cannot open file " + name, fkClass, "OpenRFile");
    return kInvalidId;
  }
 
  // newFile->add_unziper('Z',tools::decompress_buffer);
 
  // add file in a map
  fRFiles[name] = G4Hdf5File(newFile, kInvalidId, kInvalidId);
 
  Message(kVL1, "open", "read analysis file", name);
 
  return newFile;
}

References fkClass, fRFiles, G4BaseFileManager::GetFullFileName(), G4Analysis::kInvalidId, G4Analysis::kVL1, G4Analysis::kVL4, G4BaseFileManager::Message(), G4InuclParticleNames::name(), and G4Analysis::Warn().

Referenced by GetRDirectory().

◆ SetFileName()

G4bool G4BaseFileManager::SetFileName ( const G4String & fileName )

inlinevirtualinherited

Reimplemented in G4VFileManager.

Definition at line 99 of file G4BaseFileManager.hh.

                                                                     {
  // CHECK if still needed in this base class
  fFileName = fileName;
  return true;
}

References G4BaseFileManager::fFileName.

Referenced by G4VFileManager::SetFileName().

Field Documentation

◆ fFileName

G4String G4BaseFileManager::fFileName

protectedinherited

Definition at line 95 of file G4BaseFileManager.hh.

Referenced by G4BaseFileManager::GetFileName(), G4BaseFileManager::GetFullFileName(), G4BaseFileManager::GetHnFileName(), G4BaseFileManager::GetNtupleFileName(), G4RootFileManager::GetNtupleFileName(), G4BaseFileManager::GetPlotFileName(), G4CsvFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), G4XmlFileManager::OpenFile(), and G4BaseFileManager::SetFileName().

◆ fFileNames

std::vector<G4String> G4BaseFileManager::fFileNames

protectedinherited

Definition at line 96 of file G4BaseFileManager.hh.

Referenced by G4BaseFileManager::AddFileName(), and G4BaseFileManager::GetFileNames().

◆ fgkDefaultDirectoryName

const G4String G4Hdf5RFileManager::fgkDefaultDirectoryName { "default" }

inlinestaticprivate

Definition at line 74 of file G4Hdf5RFileManager.hh.

Referenced by GetRDirectory().

◆ fH1RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h1d> > G4VRFileManager::fH1RFileManager { nullptr }

protectedinherited

Definition at line 71 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

◆ fH2RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h2d> > G4VRFileManager::fH2RFileManager { nullptr }

protectedinherited

Definition at line 72 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

◆ fH3RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::h3d> > G4VRFileManager::fH3RFileManager { nullptr }

protectedinherited

Definition at line 73 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

◆ fkClass

constexpr std::string_view G4Hdf5RFileManager::fkClass { "G4Hdf5RFileManager" }

staticconstexprprivate

Definition at line 73 of file G4Hdf5RFileManager.hh.

Referenced by OpenDirectory(), and OpenRFile().

◆ fP1RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::p1d> > G4VRFileManager::fP1RFileManager { nullptr }

protectedinherited

Definition at line 74 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

◆ fP2RFileManager

std::shared_ptr<G4VTHnRFileManager<tools::histo::p2d> > G4VRFileManager::fP2RFileManager { nullptr }

protectedinherited

Definition at line 75 of file G4VRFileManager.hh.

Referenced by G4CsvRFileManager::G4CsvRFileManager(), G4Hdf5RFileManager(), G4RootRFileManager::G4RootRFileManager(), and G4XmlRFileManager::G4XmlRFileManager().

◆ fRFiles

std::map<G4String, G4Hdf5File> G4Hdf5RFileManager::fRFiles

private

Definition at line 77 of file G4Hdf5RFileManager.hh.

Referenced by CloseFiles(), GetRFile(), and OpenRFile().

◆ fState

const G4AnalysisManagerState& G4BaseFileManager::fState

protectedinherited

Definition at line 94 of file G4BaseFileManager.hh.

Referenced by G4RootFileManager::CreateFileImpl(), G4GenericFileManager::CreateFileManager(), G4GenericFileManager::CreateNtupleFileManager(), G4BaseFileManager::GetFileType(), G4BaseFileManager::Message(), and G4XmlFileManager::OpenFile().

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

source/analysis/hdf5/include/G4Hdf5RFileManager.hh
source/analysis/hdf5/src/G4Hdf5RFileManager.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4Hdf5RFileManager() [1/2]

◆ G4Hdf5RFileManager() [2/2]

◆ ~G4Hdf5RFileManager()

Member Function Documentation

◆ AddFileName()

◆ CloseFiles()

◆ GetFileName()

◆ GetFileNames()

◆ GetFileType()

◆ GetFullFileName()

◆ GetHistoRDirectory()

◆ GetHnFileName()

◆ GetHnRFileManager()

◆ GetNtupleFileName() [1/2]

◆ GetNtupleFileName() [2/2]

◆ GetNtupleRDirectory()

◆ GetPlotFileName()

◆ GetRDirectory()

◆ GetRFile()

◆ Message()

◆ OpenDirectory()

◆ OpenRFile()

◆ SetFileName()

Field Documentation

◆ fFileName

◆ fFileNames

◆ fgkDefaultDirectoryName

◆ fH1RFileManager

◆ fH2RFileManager

◆ fH3RFileManager

◆ fkClass

◆ fP1RFileManager

◆ fP2RFileManager

◆ fRFiles

◆ fState