G4VFileManager Class Reference

#include <G4VFileManager.hh>

Inheritance diagram for G4VFileManager:

Public Member Functions
	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

Protected Attributes
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 48 of file G4VFileManager.hh.

Constructor & Destructor Documentation

G4VFileManager()

G4VFileManager::G4VFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 36 of file G4VFileManager.cc.

  : G4BaseFileManager(state),
    fHistoDirectoryName(""), 
    fNtupleDirectoryName(""),
    fIsOpenFile(false),
    fLockDirectoryNames(false), 
    fH1FileManager(nullptr),
    fH2FileManager(nullptr),
    fH3FileManager(nullptr),
    fP1FileManager(nullptr),
    fP2FileManager(nullptr)
{}

~G4VFileManager()

G4VFileManager::~G4VFileManager ( )

virtual

Definition at line 50 of file G4VFileManager.cc.

{}

Member Function Documentation

CloseFile()

virtual G4bool G4VFileManager::CloseFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, G4VTFileManager< G4RootFile >, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

CloseFiles()

virtual G4bool G4VFileManager::CloseFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

CreateFile()

virtual G4bool G4VFileManager::CreateFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

DeleteEmptyFiles()

virtual G4bool G4VFileManager::DeleteEmptyFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

GetHistoDirectoryName()

G4String G4VFileManager::GetHistoDirectoryName ( ) const

inline

Definition at line 106 of file G4VFileManager.hh.

{ return fHistoDirectoryName; }  

GetHnFileManager()

template<typename HT >

std::shared_ptr< G4VTHnFileManager< HT > > G4VFileManager::GetHnFileManager

(

)

const

GetNtupleDirectoryName()

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inline

Definition at line 109 of file G4VFileManager.hh.

{ return fNtupleDirectoryName; }

IsOpenFile()

G4bool G4VFileManager::IsOpenFile ( ) const

inline

Definition at line 103 of file G4VFileManager.hh.

{ return fIsOpenFile; }

LockDirectoryNames()

void G4VFileManager::LockDirectoryNames ( )

inline

Definition at line 100 of file G4VFileManager.hh.

{ fLockDirectoryNames = true; }

OpenFile()

virtual G4bool G4VFileManager::OpenFile ( const G4String &  fileName )

pure virtual

Implemented in G4CsvFileManager, G4GenericFileManager, G4Hdf5FileManager, G4RootFileManager, and G4XmlFileManager.

SetFileName()

G4bool G4VFileManager::SetFileName ( const G4String &  fileName )

finalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 58 of file G4VFileManager.cc.

{
  // Check extension
  auto name = fileName;
  auto extension = G4Analysis::GetExtension(fileName);
  if ( extension.size() && GetFileType().size() && extension != GetFileType() ) {
    // replace extension
    name = G4Analysis::GetBaseName(fileName) + "." + GetFileType();
    G4ExceptionDescription description;
    description 
      << fileName << " file extension is not valid for " 
      << GetFileType() << " output." << G4endl
      << name << " will be used.";
    G4Exception("G4VFileManager::SetFileName()",
                "Analysis_W012", JustWarning, description);
  } 
 
  return G4BaseFileManager::SetFileName(name);
}

Referenced by G4GenericFileManager::OpenFile().

SetHistoDirectoryName()

G4bool G4VFileManager::SetHistoDirectoryName

(

const G4String &

dirName

)

Definition at line 79 of file G4VFileManager.cc.

{
  if ( fLockDirectoryNames ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set Histo directory name as its value was already used.";
    G4Exception("G4VFileManager::SetHistoDirectoryName()",
                "Analysis_W012", JustWarning, description);
    return false;
  }              
 
  fHistoDirectoryName = dirName;
  return true;
}  

SetIsEmpty()

virtual G4bool G4VFileManager::SetIsEmpty ( const G4String &  fileName, G4bool  isEmpty  )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

SetNtupleDirectoryName()

G4bool G4VFileManager::SetNtupleDirectoryName

(

const G4String &

dirName

)

Definition at line 95 of file G4VFileManager.cc.

{
  if ( fLockDirectoryNames ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set Ntuple directory name as its value was already used.";
    G4Exception("G4VFileManager::SetNtupleDirectoryName()",
                "Analysis_W012", JustWarning, description);
    return false;
  }              
 
  fNtupleDirectoryName = dirName;
  return true;
}

WriteFile()

virtual G4bool G4VFileManager::WriteFile ( const G4String &  fileName )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, G4VTFileManager< G4RootFile >, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

WriteFiles()

virtual G4bool G4VFileManager::WriteFiles ( )

pure virtual

Implemented in G4GenericFileManager, G4VTFileManager< FT >, G4VTFileManager< std::ofstream >, G4VTFileManager< G4Hdf5File >, and G4VTFileManager< G4RootFile >.

Member Data Documentation

fH1FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h1d> > G4VFileManager::fH1FileManager

protected

Definition at line 91 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fH2FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h2d> > G4VFileManager::fH2FileManager

protected

Definition at line 92 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fH3FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::h3d> > G4VFileManager::fH3FileManager

protected

Definition at line 93 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fHistoDirectoryName

G4String G4VFileManager::fHistoDirectoryName

protected

Definition at line 85 of file G4VFileManager.hh.

Referenced by G4Hdf5FileManager::CreateFileImpl(), G4RootFileManager::CreateFileImpl(), GetHistoDirectoryName(), and SetHistoDirectoryName().

fIsOpenFile

G4bool G4VFileManager::fIsOpenFile

protected

Definition at line 87 of file G4VFileManager.hh.

Referenced by G4VTFileManager< FT >::CloseFiles(), IsOpenFile(), G4CsvFileManager::OpenFile(), G4GenericFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), and G4XmlFileManager::OpenFile().

fLockDirectoryNames

G4bool G4VFileManager::fLockDirectoryNames

protected

Definition at line 88 of file G4VFileManager.hh.

Referenced by LockDirectoryNames(), G4GenericFileManager::OpenFile(), G4Hdf5FileManager::OpenFile(), G4RootFileManager::OpenFile(), SetHistoDirectoryName(), and SetNtupleDirectoryName().

fNtupleDirectoryName

G4String G4VFileManager::fNtupleDirectoryName

protected

Definition at line 86 of file G4VFileManager.hh.

Referenced by G4Hdf5FileManager::CreateFileImpl(), G4RootFileManager::CreateFileImpl(), GetNtupleDirectoryName(), and SetNtupleDirectoryName().

fP1FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::p1d> > G4VFileManager::fP1FileManager

protected

Definition at line 94 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

fP2FileManager

std::shared_ptr<G4VTHnFileManager<tools::histo::p2d> > G4VFileManager::fP2FileManager

protected

Definition at line 95 of file G4VFileManager.hh.

Referenced by G4CsvFileManager::G4CsvFileManager(), G4Hdf5FileManager::G4Hdf5FileManager(), G4RootFileManager::G4RootFileManager(), and G4XmlFileManager::G4XmlFileManager().

---

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

• G4VFileManager.hh
• G4VFileManager.cc