G4RootFileManager Class Reference

#include <G4RootFileManager.hh>

Inheritance diagram for G4RootFileManager:

Public Member Functions
	G4RootFileManager (const G4AnalysisManagerState &state)
virtual	~G4RootFileManager ()
virtual G4bool	OpenFile (const G4String &fileName) final
virtual G4String	GetFileType () 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	WriteNtupleFile (RootNtupleDescription *ntupleDescription)
G4bool	CloseNtupleFile (RootNtupleDescription *ntupleDescription)
void	SetBasketSize (unsigned int basketSize)
void	SetBasketEntries (unsigned int basketEntries)
unsigned int	GetBasketSize () const
unsigned int	GetBasketEntries () const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
Public Member Functions inherited from G4VTFileManager< G4RootFile >
	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< G4RootFile >	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< G4RootFile >	CreateFileImpl (const G4String &fileName) final
virtual G4bool	WriteFileImpl (std::shared_ptr< G4RootFile > file) final
virtual G4bool	CloseFileImpl (std::shared_ptr< G4RootFile > 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< G4RootFile >
std::shared_ptr< G4RootFile >	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 51 of file G4RootFileManager.hh.

Constructor & Destructor Documentation

G4RootFileManager()

G4RootFileManager::G4RootFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 45 of file G4RootFileManager.cc.

 : G4VTFileManager<G4RootFile>(state),
   fBasketSize(0),
   fBasketEntries(0)
{
  // 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()

G4RootFileManager::~G4RootFileManager ( )

virtual

Definition at line 59 of file G4RootFileManager.cc.

{}

Member Function Documentation

CloseFileImpl()

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

finalprotectedvirtual

Definition at line 187 of file G4RootFileManager.cc.

{
// New prototype: called by G4TFileManager base classe
 
  if ( ! file ) return false;
 
  // close file
  std::get<0>(*file)->close();
 
  return true;
}

CloseNtupleFile()

G4bool G4RootFileManager::CloseNtupleFile

(

RootNtupleDescription *

ntupleDescription

)

Definition at line 268 of file G4RootFileManager.cc.

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

CreateFileImpl()

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

finalprotectedvirtual

Implements G4TFileManager< FT >.

Definition at line 141 of file G4RootFileManager.cc.

{
  // create file
  std::shared_ptr<wroot::file> file = std::make_shared<wroot::file>(G4cout, fileName);
  file->add_ziper('Z',compress_buffer);
  file->set_compression(fState.GetCompressionLevel());
  
  if ( ! file->is_open() ) {
    G4ExceptionDescription description;
    description << "      " << "Cannot create file " << fileName;
    G4Exception("G4RootFileManager::CreateFileImpl()",
                "Analysis_W001", JustWarning, description);
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  }
 
  // create histo directory
  tools::wroot::directory* hdirectory 
    = CreateDirectory(file, fHistoDirectoryName, "histograms");
  if ( ! hdirectory ) {
    // Warning is issued in CreateDirectory
    return std::make_shared<G4RootFile>(nullptr, nullptr, nullptr);
  } 
 
  // create ntuple directory
  tools::wroot::directory* ndirectory 
    = CreateDirectory(file, fNtupleDirectoryName, "ntuples");
  if ( ! ndirectory ) {
    // 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 236 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->fFile = file;
  }
 
  return file;
}

GetBasketEntries()

unsigned int G4RootFileManager::GetBasketEntries ( ) const

inline

Definition at line 120 of file G4RootFileManager.hh.

{ return fBasketEntries; }

GetBasketSize()

unsigned int G4RootFileManager::GetBasketSize ( ) const

inline

Definition at line 116 of file G4RootFileManager.hh.

{ return fBasketSize; }

GetFileType()

virtual G4String G4RootFileManager::GetFileType ( ) const

inlinefinalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 64 of file G4RootFileManager.hh.

{ return "root"; }

GetNtupleFile()

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

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

)

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

finalvirtual

Implements G4VFileManager.

Definition at line 203 of file G4RootFileManager.cc.

{
// Open default file
 
  // Keep file name
  fFileName =  fileName;
  auto name = GetFullFileName();
 
  if ( fFile ) {
    G4ExceptionDescription description;
    description << "File " << fileName << " already exists.";
    G4Exception("G4RootFileManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    fFile.reset();
  }
 
  // Create file (and save in in the file map)
  fFile = CreateTFile(name);
  if ( ! fFile ) {
    G4ExceptionDescription description;
    description << "Failed to create file " << fileName;
    G4Exception("G4RootFileManager::OpenFile()",
                "Analysis_W001", JustWarning, description);
    return false;
  }
 
  fIsOpenFile = true;
  fLockDirectoryNames = true;
 
  return true;
}

SetBasketEntries()

void G4RootFileManager::SetBasketEntries ( unsigned int  basketEntries )

inline

Definition at line 112 of file G4RootFileManager.hh.

{ fBasketEntries = basketEntries; }

SetBasketSize()

void G4RootFileManager::SetBasketSize ( unsigned int  basketSize )

inline

Definition at line 108 of file G4RootFileManager.hh.

{ fBasketSize = basketSize; }

WriteFileImpl()

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

finalprotectedvirtual

Definition at line 176 of file G4RootFileManager.cc.

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

WriteNtupleFile()

G4bool G4RootFileManager::WriteNtupleFile

(

RootNtupleDescription *

ntupleDescription

)

---

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

• G4RootFileManager.hh
• G4RootFileManager.cc