G4Hdf5FileManager Class Reference

#include <G4Hdf5FileManager.hh>

Inheritance diagram for G4Hdf5FileManager:

Public Member Functions
	G4Hdf5FileManager (const G4AnalysisManagerState &state)
	~G4Hdf5FileManager ()
virtual G4bool	OpenFile (const G4String &fileName) final
virtual 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) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
Public Member Functions inherited from G4VTFileManager< G4Hdf5File >
	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< G4Hdf5File >	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< G4Hdf5File >	CreateFileImpl (const G4String &fileName) final
virtual G4bool	WriteFileImpl (std::shared_ptr< G4Hdf5File > file) final
virtual G4bool	CloseFileImpl (std::shared_ptr< G4Hdf5File > 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< G4Hdf5File >
std::shared_ptr< G4Hdf5File >	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 45 of file G4Hdf5FileManager.hh.

Constructor & Destructor Documentation

G4Hdf5FileManager()

G4Hdf5FileManager::G4Hdf5FileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 51 of file G4Hdf5FileManager.cc.

 : G4VTFileManager<G4Hdf5File>(state),
   fBasketSize(0)          // TO DO: check default value !! (433 in test)
{
  // 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()

G4Hdf5FileManager::~G4Hdf5FileManager

(

)

Definition at line 64 of file G4Hdf5FileManager.cc.

{}

Member Function Documentation

CloseFileImpl()

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

finalprotectedvirtual

Definition at line 203 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 271 of file G4Hdf5FileManager.cc.

{
  // Do nothing if there is no file
  if ( ! ntupleDescription->fFile ) return true;
 
  // Ntuple files will be closed with CloseFiles() calls
  ntupleDescription->fFile.reset();
 
  // Notify not empty file
  auto ntupleFileName = GetNtupleFileName(ntupleDescription);
  auto result = SetIsEmpty(ntupleFileName, ! ntupleDescription->fHasFill);
 
  return result;
}

CreateFileImpl()

std::shared_ptr< G4Hdf5File > G4Hdf5FileManager::CreateFileImpl ( const G4String &  fileName )

finalprotectedvirtual

Implements G4TFileManager< FT >.

Definition at line 152 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 ) {
    G4ExceptionDescription description;
    description << "      " << "::H5Fcreate failed " << fileName;
    G4Exception("G4Hdf5AnalysisManager::CreateFileImpl()",
                "Analysis_W001", JustWarning, description);
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  // create a header with general infos
  if(!tools::hdf5::write_header(file)) {
    G4ExceptionDescription description;
    description << "      " << "tools::hdf5::write_header() failed for " << fileName;
    G4Exception("G4Hdf5AnalysisManager::CreateFileImpl()",
                "Analysis_W001", JustWarning, description);
    return std::make_shared<G4Hdf5File>(-1, -1, -1);
  }
 
  // create histo directory
  auto hdirectory
    = CreateDirectory(file, fHistoDirectoryName, "histograms");
  if ( hdirectory < 0 ) {
    // Warnin 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 255 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->fFile = file;
 
  return (ntupleDescription->fFile != nullptr);
}

GetBasketSize()

unsigned int G4Hdf5FileManager::GetBasketSize ( ) const

inline

Definition at line 97 of file G4Hdf5FileManager.hh.

{ return fBasketSize; }

GetFileType()

virtual G4String G4Hdf5FileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 58 of file G4Hdf5FileManager.hh.

{ return "hdf5"; }

GetHistoDirectory()

hid_t G4Hdf5FileManager::GetHistoDirectory

(

)

const

Definition at line 288 of file G4Hdf5FileManager.cc.

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

GetNtupleDirectory()

hid_t G4Hdf5FileManager::GetNtupleDirectory

(

)

const

Definition at line 296 of file G4Hdf5FileManager.cc.

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

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

finalvirtual

Implements G4VFileManager.

Definition at line 223 of file G4Hdf5FileManager.cc.

{
  // Keep file name
  fFileName = fileName;
  auto name = GetFullFileName();
 
  if ( fFile ) {
    G4ExceptionDescription description;
    description 
      << "File " << fileName << " already exists."; 
    G4Exception("G4Hdf5FileManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    fFile.reset();
  }
 
  // create new file
  fFile = CreateTFile(name);
  if ( ! fFile ) {
    G4ExceptionDescription description;
    description << "Failed to create file " << fileName;
    G4Exception("G4Hdf5FileManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    return false;
  }
 
  fLockDirectoryNames = true;
  fIsOpenFile = true;
 
  return true;
}

SetBasketSize()

void G4Hdf5FileManager::SetBasketSize ( unsigned int  basketSize )

inline

Definition at line 93 of file G4Hdf5FileManager.hh.

{ fBasketSize = basketSize; }

WriteFileImpl()

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

finalprotectedvirtual

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