G4CsvNtupleManager Class Reference

#include <G4CsvNtupleManager.hh>

Inheritance diagram for G4CsvNtupleManager:

Collaboration diagram for G4CsvNtupleManager:

Public Member Functions
	G4CsvNtupleManager (const G4AnalysisManagerState &state)
	~G4CsvNtupleManager ()
Public Member Functions inherited from G4TNtupleManager< tools::wcsv::ntuple >
	G4TNtupleManager (const G4AnalysisManagerState &state)
	~G4TNtupleManager ()
Public Member Functions inherited from G4VNtupleManager
	G4VNtupleManager (const G4AnalysisManagerState &state)
virtual	~G4VNtupleManager ()
	G4VNtupleManager (const G4VNtupleManager &rhs)=delete
G4VNtupleManager &	operator= (const G4VNtupleManager &rhs)=delete
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
virtual	~G4BaseAnalysisManager ()
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () const

Private Types
using	NtupleType = tools::wcsv::ntuple
using	NtupleDescriptionType = G4TNtupleDescription< NtupleType >

Private Member Functions
void	SetFileManager (std::shared_ptr< G4CsvFileManager > fileManager)
const std::vector< NtupleDescriptionType * > &	GetNtupleDescriptionVector () const
void	SetIsCommentedHeader (G4bool isCommentedHeader)
void	SetIsHippoHeader (G4bool isHippoHeader)
virtual void	CreateTNtuple (NtupleDescriptionType *ntupleDescription, const G4String &name, const G4String &title) final
virtual void	CreateTNtupleFromBooking (NtupleDescriptionType *ntupleDescription) final
virtual void	FinishTNtuple (NtupleDescriptionType *ntupleDescription) final
G4bool	WriteHeader (NtupleType *ntuple) const

Private Attributes
std::shared_ptr< G4CsvFileManager >	fFileManager
G4bool	fIsCommentedHeader
G4bool	fIsHippoHeader

Friends
class	G4CsvAnalysisManager

Additional Inherited Members
Protected Member Functions inherited from G4TNtupleManager< tools::wcsv::ntuple >
void	CreateNtuplesFromBooking ()
G4bool	IsEmpty () const
G4bool	Reset (G4bool deleteNtuple)
virtual G4int	CreateNtuple (const G4String &name, const G4String &title) final
virtual G4int	CreateNtupleIColumn (const G4String &name, std::vector< int > *vector) final
virtual G4int	CreateNtupleIColumn (G4int ntupleId, const G4String &name, std::vector< int > *vector) final
virtual G4int	CreateNtupleFColumn (const G4String &name, std::vector< float > *vector) final
virtual G4int	CreateNtupleFColumn (G4int ntupleId, const G4String &name, std::vector< float > *vector) final
virtual G4int	CreateNtupleDColumn (const G4String &name, std::vector< double > *vector) final
virtual G4int	CreateNtupleDColumn (G4int ntupleId, const G4String &name, std::vector< double > *vector) final
virtual G4int	CreateNtupleSColumn (const G4String &name) final
virtual G4int	CreateNtupleSColumn (G4int ntupleId, const G4String &name) final
virtual void	FinishNtuple () final
virtual void	FinishNtuple (G4int ntupleId) final
virtual G4bool	FillNtupleIColumn (G4int columnId, G4int value) final
virtual G4bool	FillNtupleIColumn (G4int ntupleId, G4int columnId, G4int value) final
virtual G4bool	FillNtupleFColumn (G4int columnId, G4float value) final
virtual G4bool	FillNtupleFColumn (G4int ntupleId, G4int columnId, G4float value) final
virtual G4bool	FillNtupleDColumn (G4int columnId, G4double value) final
virtual G4bool	FillNtupleDColumn (G4int ntupleId, G4int columnId, G4double value) final
virtual G4bool	FillNtupleSColumn (G4int columnId, const G4String &value) final
virtual G4bool	FillNtupleSColumn (G4int ntupleId, G4int columnId, const G4String &value) final
virtual G4bool	AddNtupleRow () final
virtual G4bool	AddNtupleRow (G4int ntupleId) final
virtual void	SetActivation (G4bool activation) final
virtual void	SetActivation (G4int ntupleId, G4bool activation) final
virtual G4bool	GetActivation (G4int ntupleId) const final
tools::wcsv::ntuple *	GetNtuple () const
tools::wcsv::ntuple *	GetNtuple (G4int ntupleId) const
virtual G4int	GetNofNtuples () const final
std::vector< tools::wcsv::ntuple *>::iterator	BeginNtuple ()
std::vector< tools::wcsv::ntuple *>::iterator	EndNtuple ()
std::vector< tools::wcsv::ntuple *>::const_iterator	BeginConstNtuple () const
std::vector< tools::wcsv::ntuple *>::const_iterator	EndConstNtuple () const
Protected Member Functions inherited from G4VNtupleManager
G4bool	SetFirstNtupleColumnId (G4int firstId)
G4int	GetFirstNtupleColumnId () const
Protected Attributes inherited from G4TNtupleManager< tools::wcsv::ntuple >
std::vector< G4TNtupleDescription< tools::wcsv::ntuple > *>	fNtupleDescriptionVector
std::vector< tools::wcsv::ntuple *>	fNtupleVector
Protected Attributes inherited from G4VNtupleManager
G4int	fFirstNtupleColumnId
G4bool	fLockFirstNtupleColumnId
Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState
G4int	fFirstId
G4bool	fLockFirstId

Detailed Description

Definition at line 44 of file G4CsvNtupleManager.hh.

Member Typedef Documentation

NtupleDescriptionType

using G4CsvNtupleManager::NtupleDescriptionType = G4TNtupleDescription<NtupleType>

private

Definition at line 55 of file G4CsvNtupleManager.hh.

NtupleType

using G4CsvNtupleManager::NtupleType = tools::wcsv::ntuple

private

Definition at line 54 of file G4CsvNtupleManager.hh.

Constructor & Destructor Documentation

G4CsvNtupleManager()

G4CsvNtupleManager::G4CsvNtupleManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 46 of file G4CsvNtupleManager.cc.

 : G4TNtupleManager<tools::wcsv::ntuple>(state),
   fFileManager(nullptr),
   fIsCommentedHeader(true),
   fIsHippoHeader(false)
{}

~G4CsvNtupleManager()

G4CsvNtupleManager::~G4CsvNtupleManager

(

)

Definition at line 54 of file G4CsvNtupleManager.cc.

{}

Member Function Documentation

CreateTNtuple()

void G4CsvNtupleManager::CreateTNtuple ( NtupleDescriptionType *  ntupleDescription, const G4String &  name, const G4String &  title  )

finalprivatevirtual

Definition at line 62 of file G4CsvNtupleManager.cc.

{
  // Create ntuple if the file is open (what means here that
  // a filename was already set)
  if ( fFileManager->GetFileName().size() ) {
    if ( fFileManager->CreateNtupleFile(ntupleDescription) ) {
      ntupleDescription->fNtuple 
        = new tools::wcsv::ntuple(*(ntupleDescription->fFile));
           // ntuple object is deleted when closing a file
      (ntupleDescription->fNtuple)->set_title(title); 
      fNtupleVector.push_back(ntupleDescription->fNtuple);       
    }       
  }  
}

CreateTNtupleFromBooking()

void G4CsvNtupleManager::CreateTNtupleFromBooking ( NtupleDescriptionType *  ntupleDescription )

finalprivatevirtual

Definition at line 80 of file G4CsvNtupleManager.cc.

{
    // create a file for this ntuple
    if ( ! fFileManager->CreateNtupleFile(ntupleDescription) ) return;

    // create ntuple
    ntupleDescription->fNtuple
      = new tools::wcsv::ntuple(
              *(ntupleDescription->fFile), G4cerr, ntupleDescription->fNtupleBooking);
    fNtupleVector.push_back(ntupleDescription->fNtuple);  
  
    // write header (if activated)
    if ( ! WriteHeader(ntupleDescription->fNtuple) ) {
       G4ExceptionDescription description;
       description << "      " 
                   << "Writing ntuple header has failed. ";
       G4Exception("G4CsvNtupleManager::CreateNtupleFromBooking()",
                   "Analysis_W021", JustWarning, description);
    }
 }

Here is the call graph for this function:

FinishTNtuple()

void G4CsvNtupleManager::FinishTNtuple ( NtupleDescriptionType *  ntupleDescription )

finalprivatevirtual

Definition at line 103 of file G4CsvNtupleManager.cc.

{
  // Write header if ntuple already exists
  if ( ! WriteHeader(ntupleDescription->fNtuple) ) {
     G4ExceptionDescription description;
     description << "      " 
                 << "Writing ntuple header has failed. ";
     G4Exception("G4CsvNtupleManager::FinishTNtuple()",
                 "Analysis_W022", JustWarning, description);
  }
}

Here is the call graph for this function:

GetNtupleDescriptionVector()

const std::vector< G4TNtupleDescription< tools::wcsv::ntuple > * > & G4CsvNtupleManager::GetNtupleDescriptionVector ( ) const

inlineprivate

Definition at line 94 of file G4CsvNtupleManager.hh.

{ return fNtupleDescriptionVector; }

Here is the caller graph for this function:

SetFileManager()

void G4CsvNtupleManager::SetFileManager ( std::shared_ptr< G4CsvFileManager >  fileManager )

inlineprivate

Definition at line 90 of file G4CsvNtupleManager.hh.

{ fFileManager = fileManager; }

Here is the caller graph for this function:

SetIsCommentedHeader()

void G4CsvNtupleManager::SetIsCommentedHeader ( G4bool  isCommentedHeader )

inlineprivate

Definition at line 97 of file G4CsvNtupleManager.hh.

{ fIsCommentedHeader = isCommentedHeader; }

SetIsHippoHeader()

void G4CsvNtupleManager::SetIsHippoHeader ( G4bool  isHippoHeader )

inlineprivate

Definition at line 100 of file G4CsvNtupleManager.hh.

{ fIsHippoHeader = isHippoHeader; }

WriteHeader()

G4bool G4CsvNtupleManager::WriteHeader ( NtupleType *  ntuple ) const

private

Definition at line 117 of file G4CsvNtupleManager.cc.

{
// Write header if ntuple already exists and if this option is activated.
// When both Hippo and Commented headers are selected, only Commented
// header, which reading is supported.
// Return false only if an error occurred. 

  if ( fIsCommentedHeader ) {
    return ntuple->write_commented_header(G4cout);
  }
  
  // write hippo header (if activated and if not commented header)
  if ( fIsHippoHeader ) {
    ntuple->write_hippo_header();
    return true;
  }
  
  return true;
}

Here is the caller graph for this function:

Friends And Related Function Documentation

G4CsvAnalysisManager

friend class G4CsvAnalysisManager

friend

Definition at line 46 of file G4CsvNtupleManager.hh.

Member Data Documentation

fFileManager

std::shared_ptr<G4CsvFileManager> G4CsvNtupleManager::fFileManager

private

Definition at line 82 of file G4CsvNtupleManager.hh.

fIsCommentedHeader

G4bool G4CsvNtupleManager::fIsCommentedHeader

private

Definition at line 83 of file G4CsvNtupleManager.hh.

fIsHippoHeader

G4bool G4CsvNtupleManager::fIsHippoHeader

private

Definition at line 84 of file G4CsvNtupleManager.hh.

---

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

• G4CsvNtupleManager.hh
• G4CsvNtupleManager.cc