G4XmlNtupleManager Class Reference

#include <G4XmlNtupleManager.hh>

Inheritance diagram for G4XmlNtupleManager:

Collaboration diagram for G4XmlNtupleManager:

Public Member Functions
	G4XmlNtupleManager (const G4AnalysisManagerState &state)
	~G4XmlNtupleManager ()
Public Member Functions inherited from G4TNtupleManager< tools::waxml::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::waxml::ntuple
using	NtupleDescriptionType = G4TNtupleDescription< NtupleType >

Private Member Functions
void	SetFileManager (std::shared_ptr< G4XmlFileManager > fileManager)
const std::vector< NtupleDescriptionType * > &	GetNtupleDescriptionVector () const
virtual void	CreateTNtuple (NtupleDescriptionType *ntupleDescription, const G4String &name, const G4String &title) final
virtual void	CreateTNtupleFromBooking (NtupleDescriptionType *ntupleDescription) final
virtual void	FinishTNtuple (NtupleDescriptionType *ntupleDescription) final

Private Attributes
std::shared_ptr< G4XmlFileManager >	fFileManager

Friends
class	G4XmlAnalysisManager

Additional Inherited Members
Protected Member Functions inherited from G4TNtupleManager< tools::waxml::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::waxml::ntuple *	GetNtuple () const
tools::waxml::ntuple *	GetNtuple (G4int ntupleId) const
virtual G4int	GetNofNtuples () const final
std::vector< tools::waxml::ntuple *>::iterator	BeginNtuple ()
std::vector< tools::waxml::ntuple *>::iterator	EndNtuple ()
std::vector< tools::waxml::ntuple *>::const_iterator	BeginConstNtuple () const
std::vector< tools::waxml::ntuple *>::const_iterator	EndConstNtuple () const
Protected Member Functions inherited from G4VNtupleManager
G4bool	SetFirstNtupleColumnId (G4int firstId)
G4int	GetFirstNtupleColumnId () const
Protected Attributes inherited from G4TNtupleManager< tools::waxml::ntuple >
std::vector< G4TNtupleDescription< tools::waxml::ntuple > *>	fNtupleDescriptionVector
std::vector< tools::waxml::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 45 of file G4XmlNtupleManager.hh.

Member Typedef Documentation

NtupleDescriptionType

using G4XmlNtupleManager::NtupleDescriptionType = G4TNtupleDescription<NtupleType>

private

Definition at line 56 of file G4XmlNtupleManager.hh.

NtupleType

using G4XmlNtupleManager::NtupleType = tools::waxml::ntuple

private

Definition at line 55 of file G4XmlNtupleManager.hh.

Constructor & Destructor Documentation

G4XmlNtupleManager()

G4XmlNtupleManager::G4XmlNtupleManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 45 of file G4XmlNtupleManager.cc.

 : G4TNtupleManager<tools::waxml::ntuple>(state),
   fFileManager(nullptr)
{}

~G4XmlNtupleManager()

G4XmlNtupleManager::~G4XmlNtupleManager

(

)

Definition at line 51 of file G4XmlNtupleManager.cc.

{}

Member Function Documentation

CreateTNtuple()

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

finalprivatevirtual

Definition at line 59 of file G4XmlNtupleManager.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::waxml::ntuple(*(ntupleDescription->fFile));
           // ntuple object is deleted when closing a file
      fNtupleVector.push_back(ntupleDescription->fNtuple);       
    }       
  }
}

CreateTNtupleFromBooking()

void G4XmlNtupleManager::CreateTNtupleFromBooking ( NtupleDescriptionType *  ntupleDescription )

finalprivatevirtual

Definition at line 76 of file G4XmlNtupleManager.cc.

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

    // create ntuple
    ntupleDescription->fNtuple
      = new tools::waxml::ntuple(
              *(ntupleDescription->fFile), G4cerr, ntupleDescription->fNtupleBooking);
    fNtupleVector.push_back(ntupleDescription->fNtuple);  
}

FinishTNtuple()

void G4XmlNtupleManager::FinishTNtuple ( NtupleDescriptionType *  ntupleDescription )

finalprivatevirtual

Definition at line 90 of file G4XmlNtupleManager.cc.

{
  G4String path = "/";
  path.append(fFileManager->GetNtupleDirectoryName());
  ntupleDescription->fNtuple
    ->write_header(path, ntupleDescription->fNtupleBooking.name(), 
                   ntupleDescription->fNtupleBooking.title());  
  fFileManager->LockNtupleDirectoryName();
}

Here is the call graph for this function:

GetNtupleDescriptionVector()

const std::vector< G4TNtupleDescription< tools::waxml::ntuple > * > & G4XmlNtupleManager::GetNtupleDescriptionVector ( ) const

inlineprivate

Definition at line 90 of file G4XmlNtupleManager.hh.

{ return fNtupleDescriptionVector; }

Here is the caller graph for this function:

SetFileManager()

void G4XmlNtupleManager::SetFileManager ( std::shared_ptr< G4XmlFileManager >  fileManager )

inlineprivate

Definition at line 86 of file G4XmlNtupleManager.hh.

{ fFileManager = fileManager; }

Here is the caller graph for this function:

Friends And Related Function Documentation

G4XmlAnalysisManager

friend class G4XmlAnalysisManager

friend

Definition at line 47 of file G4XmlNtupleManager.hh.

Member Data Documentation

fFileManager

std::shared_ptr<G4XmlFileManager> G4XmlNtupleManager::fFileManager

private

Definition at line 80 of file G4XmlNtupleManager.hh.

---

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

• G4XmlNtupleManager.hh
• G4XmlNtupleManager.cc