G4VFileManager Class Reference

#include <G4VFileManager.hh>

Inheritance diagram for G4VFileManager:

Collaboration diagram for G4VFileManager:

Public Member Functions
	G4VFileManager (const G4AnalysisManagerState &state)
virtual	~G4VFileManager ()
virtual G4bool	OpenFile (const G4String &fileName)=0
virtual G4bool	WriteFile ()=0
virtual G4bool	CloseFile ()=0
virtual G4bool	SetFileName (const G4String &fileName) final
void	LockHistoDirectoryName ()
void	LockNtupleDirectoryName ()
G4bool	SetHistoDirectoryName (const G4String &dirName)
G4bool	SetNtupleDirectoryName (const G4String &dirName)
G4bool	IsOpenFile () const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
Public Member Functions inherited from G4BaseFileManager
	G4BaseFileManager (const G4AnalysisManagerState &state)
virtual	~G4BaseFileManager ()
G4String	GetFileName () const
G4String	GetFullFileName (const G4String &baseFileName="", G4bool isPerThread=true) const
G4String	GetHnFileName (const G4String &hnType, const G4String &hnName) const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetNtupleFileName (G4int ntupleFileNumber) const
G4String	GetPlotFileName () const
G4String	GetFileType () const

Protected Attributes
G4bool	fIsOpenFile
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fLockFileName
G4bool	fLockHistoDirectoryName
G4bool	fLockNtupleDirectoryName
Protected Attributes inherited from G4BaseFileManager
const G4AnalysisManagerState &	fState
G4String	fFileName

Additional Inherited Members
Protected Member Functions inherited from G4BaseFileManager
G4String	TakeOffExtension (G4String &name) const

Detailed Description

Definition at line 38 of file G4VFileManager.hh.

Constructor & Destructor Documentation

G4VFileManager::G4VFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 36 of file G4VFileManager.cc.

  : G4BaseFileManager(state),
    fIsOpenFile(false),
    fHistoDirectoryName(""), 
    fNtupleDirectoryName(""),
    fLockFileName(false),
    fLockHistoDirectoryName(false), 
    fLockNtupleDirectoryName(false)
{}

G4VFileManager::~G4VFileManager ( )

virtual

Definition at line 47 of file G4VFileManager.cc.

{}

Member Function Documentation

virtual G4bool G4VFileManager::CloseFile ( )

pure virtual

Implemented in G4XmlFileManager, G4RootFileManager, and G4CsvFileManager.

G4String G4VFileManager::GetHistoDirectoryName ( ) const

inline

Definition at line 85 of file G4VFileManager.hh.

                                                            {
  return fHistoDirectoryName;
}  

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inline

Definition at line 89 of file G4VFileManager.hh.

                                                             {
  return fNtupleDirectoryName;
}  

G4bool G4VFileManager::IsOpenFile ( ) const

inline

Definition at line 75 of file G4VFileManager.hh.

{ return fIsOpenFile; }

void G4VFileManager::LockHistoDirectoryName ( )

inline

Definition at line 78 of file G4VFileManager.hh.

{ fLockHistoDirectoryName = true; }

void G4VFileManager::LockNtupleDirectoryName ( )

inline

Definition at line 81 of file G4VFileManager.hh.

{ fLockNtupleDirectoryName = true; }

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

pure virtual

Implemented in G4XmlFileManager, G4RootFileManager, and G4CsvFileManager.

G4bool G4VFileManager::SetFileName ( const G4String &  fileName )

finalvirtual

Reimplemented from G4BaseFileManager.

Definition at line 55 of file G4VFileManager.cc.

{
  if ( fLockFileName ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set File name as its value was already used.";
    G4Exception("G4VFileManager::SetFileName()",
                "Analysis_W012", JustWarning, description);
    return false;
  }              

  return G4BaseFileManager::SetFileName(fileName);
}  

Here is the call graph for this function:

G4bool G4VFileManager::SetHistoDirectoryName

(

const G4String &

dirName

)

Definition at line 70 of file G4VFileManager.cc.

{
  if ( fLockHistoDirectoryName ) {
    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;
}  

Here is the call graph for this function:

G4bool G4VFileManager::SetNtupleDirectoryName

(

const G4String &

dirName

)

Definition at line 86 of file G4VFileManager.cc.

{
  if ( fLockNtupleDirectoryName ) {
    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;
}  

Here is the call graph for this function:

virtual G4bool G4VFileManager::WriteFile ( )

pure virtual

Implemented in G4XmlFileManager, G4RootFileManager, and G4CsvFileManager.

Member Data Documentation

G4String G4VFileManager::fHistoDirectoryName

protected

Definition at line 66 of file G4VFileManager.hh.

G4bool G4VFileManager::fIsOpenFile

protected

Definition at line 65 of file G4VFileManager.hh.

G4bool G4VFileManager::fLockFileName

protected

Definition at line 68 of file G4VFileManager.hh.

G4bool G4VFileManager::fLockHistoDirectoryName

protected

Definition at line 69 of file G4VFileManager.hh.

G4bool G4VFileManager::fLockNtupleDirectoryName

protected

Definition at line 70 of file G4VFileManager.hh.

G4String G4VFileManager::fNtupleDirectoryName

protected

Definition at line 67 of file G4VFileManager.hh.

---

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

• geant4.10.03.p01/source/analysis/management/include/G4VFileManager.hh
• geant4.10.03.p01/source/analysis/management/src/G4VFileManager.cc