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	WriteFile ()=0
virtual G4bool	CloseFile ()=0
G4bool	SetFileName (const G4String &fileName)
G4bool	SetHistoDirectoryName (const G4String &dirName)
G4bool	SetNtupleDirectoryName (const G4String &dirName)
G4String	GetFileName () const
G4String	GetFullFileName () const
G4String	GetNtupleFileName (const G4String &ntupleName) const
G4String	GetHistoDirectoryName () const
G4String	GetNtupleDirectoryName () const
G4String	GetFileType () const

Protected Attributes
const G4AnalysisManagerState &	fState
G4String	fFileName
G4String	fHistoDirectoryName
G4String	fNtupleDirectoryName
G4bool	fLockFileName
G4bool	fLockHistoDirectoryName
G4bool	fLockNtupleDirectoryName

Detailed Description

Definition at line 38 of file G4VFileManager.hh.

Constructor & Destructor Documentation

G4VFileManager::G4VFileManager

(

const G4AnalysisManagerState &

state

)

Definition at line 36 of file G4VFileManager.cc.

  : fState(state),
    fFileName(""), 
    fHistoDirectoryName(""), 
    fNtupleDirectoryName(""),
    fLockFileName(false),
    fLockHistoDirectoryName(false), 
    fLockNtupleDirectoryName(false)
{
}

G4VFileManager::~G4VFileManager ( )

virtual

Definition at line 48 of file G4VFileManager.cc.

{
}

Member Function Documentation

virtual G4bool G4VFileManager::CloseFile ( )

pure virtual

Implemented in G4RootFileManager, G4CsvFileManager, and G4XmlFileManager.

G4String G4VFileManager::GetFileName ( ) const

inline

Definition at line 75 of file G4VFileManager.hh.

References fFileName.

Referenced by G4XmlNtupleManager::CreateNtuple(), G4CsvNtupleManager::CreateNtuple(), G4VAnalysisManager::GetFileName(), G4VAnalysisManager::OpenFile(), G4XmlAnalysisManager::WriteImpl(), and G4RootAnalysisManager::WriteImpl().

                                                  {
  return fFileName;
}  

G4String G4VFileManager::GetFileType

(

)

const

Definition at line 147 of file G4VFileManager.cc.

References fState, G4AnalysisManagerState::GetType(), and G4String::toLower().

Referenced by GetFullFileName(), and GetNtupleFileName().

{
  G4String fileType = fState.GetType();
  fileType.toLower();
  return fileType;
}                 

G4String G4VFileManager::GetFullFileName

(

)

const

Definition at line 105 of file G4VFileManager.cc.

References G4String::append(), fFileName, fState, G4Threading::G4GetThreadId(), GetFileType(), and G4AnalysisManagerState::GetIsMaster().

Referenced by G4XmlAnalysisManager::CloseFileImpl(), G4RootAnalysisManager::CloseFileImpl(), G4XmlFileManager::CloseHnFile(), G4XmlFileManager::CreateHnFile(), G4RootFileManager::OpenFile(), G4XmlAnalysisManager::OpenFileImpl(), G4RootAnalysisManager::OpenFileImpl(), G4RootFileManager::WriteFile(), and G4XmlAnalysisManager::WriteImpl().

{  
  G4String name(fFileName);
  // Add thread Id to a file name if MT processing
  if ( ! fState.GetIsMaster() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }  
  // Add file extension .root if no extension is given
  if ( name.find(".") == std::string::npos ) { 
    name.append(".");
    name.append(GetFileType());
  }  

  return name;
}  

G4String G4VFileManager::GetHistoDirectoryName ( ) const

inline

Definition at line 79 of file G4VFileManager.hh.

References fHistoDirectoryName.

Referenced by G4VAnalysisManager::GetHistoDirectoryName().

                                                            {
  return fHistoDirectoryName;
}  

G4String G4VFileManager::GetNtupleDirectoryName ( ) const

inline

Definition at line 83 of file G4VFileManager.hh.

References fNtupleDirectoryName.

Referenced by G4XmlNtupleManager::FinishNtuple(), and G4VAnalysisManager::GetNtupleDirectoryName().

                                                             {
  return fNtupleDirectoryName;
}  

G4String G4VFileManager::GetNtupleFileName

(

const G4String &

ntupleName

)

const

Definition at line 125 of file G4VFileManager.cc.

References G4String::append(), fFileName, fState, G4Threading::G4GetThreadId(), GetFileType(), and G4AnalysisManagerState::GetIsMaster().

Referenced by G4CsvFileManager::CloseNtupleFile(), G4XmlFileManager::CloseNtupleFile(), G4CsvFileManager::CreateNtupleFile(), and G4XmlFileManager::CreateNtupleFile().

{  
  G4String name(fFileName);
  // Add ntupleName
  name.append("_");
  name.append(ntupleName);
  // Add thread Id to a file name if MT processing
  if ( ! fState.GetIsMaster() ) {
    std::ostringstream os;
    os << G4Threading::G4GetThreadId();
    name.append("_t");
    name.append(os.str());
  }  
  // Add file extension .xml if no extension is given
  if ( name.find(".") == std::string::npos ) { 
    name.append(".");
    name.append(GetFileType());
  }
  return name;
}  

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

pure virtual

Implemented in G4RootFileManager, G4CsvFileManager, and G4XmlFileManager.

G4bool G4VFileManager::SetFileName

(

const G4String &

fileName

)

Definition at line 57 of file G4VFileManager.cc.

References fFileName, fLockFileName, G4Exception(), and JustWarning.

Referenced by G4XmlAnalysisManager::OpenFileImpl(), G4RootAnalysisManager::OpenFileImpl(), and G4VAnalysisManager::SetFileName().

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

  fFileName = fileName;
  return true;
}  

G4bool G4VFileManager::SetHistoDirectoryName

(

const G4String &

dirName

)

Definition at line 73 of file G4VFileManager.cc.

References fHistoDirectoryName, fLockHistoDirectoryName, G4Exception(), and JustWarning.

Referenced by G4VAnalysisManager::SetHistoDirectoryName().

{
  if ( fLockHistoDirectoryName ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set Histo directory name as its value was already used.";
    G4Exception("G4VFileManager::SetHistoDirectoryName()",
                "Analysis_W009", JustWarning, description);
    return false;
  }              

  fHistoDirectoryName = dirName;
  return true;
}  

G4bool G4VFileManager::SetNtupleDirectoryName

(

const G4String &

dirName

)

Definition at line 89 of file G4VFileManager.cc.

References fLockNtupleDirectoryName, fNtupleDirectoryName, G4Exception(), and JustWarning.

Referenced by G4VAnalysisManager::SetNtupleDirectoryName().

{
  if ( fLockNtupleDirectoryName ) {
    G4ExceptionDescription description;
    description 
      << "Cannot set Ntuple directory name as its value was already used.";
    G4Exception("G4VFileManager::SetNtupleDirectoryName()",
                "Analysis_W010", JustWarning, description);
    return false;
  }              

  fNtupleDirectoryName = dirName;
  return true;
}  

virtual G4bool G4VFileManager::WriteFile ( )

pure virtual

Implemented in G4RootFileManager, G4CsvFileManager, and G4XmlFileManager.

Field Documentation

G4String G4VFileManager::fFileName

protected

Definition at line 65 of file G4VFileManager.hh.

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

G4String G4VFileManager::fHistoDirectoryName

protected

Definition at line 66 of file G4VFileManager.hh.

Referenced by G4RootFileManager::CreateHistoDirectory(), GetHistoDirectoryName(), and SetHistoDirectoryName().

G4bool G4VFileManager::fLockFileName

protected

Definition at line 68 of file G4VFileManager.hh.

Referenced by G4XmlFileManager::CloseFile(), G4CsvFileManager::CloseFile(), G4RootFileManager::CloseFile(), G4XmlFileManager::OpenFile(), G4CsvFileManager::OpenFile(), G4RootFileManager::OpenFile(), and SetFileName().

G4bool G4VFileManager::fLockHistoDirectoryName

protected

Definition at line 69 of file G4VFileManager.hh.

Referenced by G4XmlFileManager::LockHistoDirectoryName(), G4RootFileManager::OpenFile(), and SetHistoDirectoryName().

G4bool G4VFileManager::fLockNtupleDirectoryName

protected

Definition at line 70 of file G4VFileManager.hh.

Referenced by G4XmlFileManager::LockNtupleDirectoryName(), G4CsvFileManager::OpenFile(), G4RootFileManager::OpenFile(), and SetNtupleDirectoryName().

G4String G4VFileManager::fNtupleDirectoryName

protected

Definition at line 67 of file G4VFileManager.hh.

Referenced by G4RootFileManager::CreateNtupleDirectory(), GetNtupleDirectoryName(), and SetNtupleDirectoryName().

const G4AnalysisManagerState& G4VFileManager::fState

protected

Definition at line 64 of file G4VFileManager.hh.

Referenced by G4XmlFileManager::CloseHnFile(), G4CsvFileManager::CloseNtupleFile(), G4XmlFileManager::CloseNtupleFile(), G4RootFileManager::CreateHistoDirectory(), G4XmlFileManager::CreateHnFile(), G4RootFileManager::CreateNtupleDirectory(), G4CsvFileManager::CreateNtupleFile(), G4XmlFileManager::CreateNtupleFile(), GetFileType(), GetFullFileName(), GetNtupleFileName(), and G4RootFileManager::WriteFile().

---

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

• G4VFileManager.hh
• G4VFileManager.cc