G4TNtupleManager< NT, FT > Class Template Reference

#include <G4TNtupleManager.hh>

Inheritance diagram for G4TNtupleManager< NT, FT >:

Public Member Functions
	G4TNtupleManager ()=delete
	G4TNtupleManager (const G4AnalysisManagerState &state)
G4int	GetFirstId () const
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
	~G4TNtupleManager ()

Protected Member Functions
virtual G4bool	AddNtupleRow () final
virtual G4bool	AddNtupleRow (G4int ntupleId) override
virtual G4bool	AddNtupleRow (G4int ntupleId)=0
std::vector< NT * >::const_iterator	BeginConstNtuple () const
std::vector< NT * >::iterator	BeginNtuple ()
virtual void	Clear () override
virtual G4int	CreateNtuple (G4NtupleBooking *ntupleBooking) override
virtual void	CreateNtuplesFromBooking (const std::vector< G4NtupleBooking * > &ntupleBookings)
std::vector< NT * >::const_iterator	EndConstNtuple () const
std::vector< NT * >::iterator	EndNtuple ()
virtual G4bool	FillNtupleDColumn (G4int id, G4double value) final
virtual G4bool	FillNtupleDColumn (G4int ntupleId, G4int columnId, G4double value) final
virtual G4bool	FillNtupleDColumn (G4int ntupleId, G4int columnId, G4double value)=0
virtual G4bool	FillNtupleFColumn (G4int id, G4float value) final
virtual G4bool	FillNtupleFColumn (G4int ntupleId, G4int columnId, G4float value) final
virtual G4bool	FillNtupleFColumn (G4int ntupleId, G4int columnId, G4float value)=0
virtual G4bool	FillNtupleIColumn (G4int id, G4int value) final
virtual G4bool	FillNtupleIColumn (G4int ntupleId, G4int columnId, G4int value) final
virtual G4bool	FillNtupleIColumn (G4int ntupleId, G4int columnId, G4int value)=0
virtual G4bool	FillNtupleSColumn (G4int id, const G4String &value) final
virtual G4bool	FillNtupleSColumn (G4int ntupleId, G4int columnId, const G4String &value) final
virtual G4bool	FillNtupleSColumn (G4int ntupleId, G4int columnId, const G4String &value)=0
virtual G4bool	GetActivation (G4int ntupleId) const final
virtual G4int	GetNofNtuples () const final
NT *	GetNtuple () const
NT *	GetNtuple (G4int ntupleId) const
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
virtual G4bool	Reset ()
virtual void	SetActivation (G4bool activation) final
virtual void	SetActivation (G4int ntupleId, G4bool activation) final
virtual G4bool	SetFirstNtupleColumnId (G4int firstId) final

Protected Attributes
G4int	fFirstId { 0 }
G4int	fFirstNtupleColumnId { 0 }
G4bool	fLockFirstId { false }
std::vector< G4TNtupleDescription< NT, FT > * >	fNtupleDescriptionVector
std::vector< NT * >	fNtupleVector
const G4AnalysisManagerState &	fState

Private Member Functions
virtual void	CreateTNtupleFromBooking (G4TNtupleDescription< NT, FT > *ntupleDescription)=0
template<typename T >
G4bool	FillNtupleTColumn (G4int ntupleId, G4int columnId, const T &value)
virtual void	FinishTNtuple (G4TNtupleDescription< NT, FT > *ntupleDescription, G4bool fromBooking)=0
G4TNtupleDescription< NT, FT > *	GetNtupleDescriptionInFunction (G4int id, std::string_view function, G4bool warn=true) const
NT *	GetNtupleInFunction (G4int id, std::string_view function, G4bool warn=true) const

Static Private Attributes
static constexpr std::string_view	fkClass { "G4TNtupleManager<NT,FT>" }

Detailed Description

template<typename NT, typename FT>
class G4TNtupleManager< NT, FT >

Definition at line 43 of file G4TNtupleManager.hh.

Constructor & Destructor Documentation

G4TNtupleManager() [1/2]

template<typename NT , typename FT >

G4TNtupleManager< NT, FT >::G4TNtupleManager ( const G4AnalysisManagerState &  state )

explicit

G4TNtupleManager() [2/2]

template<typename NT , typename FT >

G4TNtupleManager< NT, FT >::G4TNtupleManager ( )

delete

~G4TNtupleManager()

template<typename NT , typename FT >

G4TNtupleManager< NT, FT >::~G4TNtupleManager

(

)

Member Function Documentation

AddNtupleRow() [1/3]

template<typename NT , typename FT >

G4bool G4BaseNtupleManager::AddNtupleRow ( )

finalprotectedvirtual

Reimplemented from G4BaseNtupleManager.

Definition at line 59 of file G4BaseNtupleManager.cc.

{
  return AddNtupleRow(fFirstId);
}

AddNtupleRow() [2/3]

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::AddNtupleRow ( G4int  ntupleId )

overrideprotectedvirtual

Implements G4BaseNtupleManager.

AddNtupleRow() [3/3]

template<typename NT , typename FT >

virtual G4bool G4BaseNtupleManager::AddNtupleRow ( G4int  ntupleId )

protectedvirtual

Implements G4BaseNtupleManager.

BeginConstNtuple()

template<typename NT , typename FT >

std::vector< NT * >::const_iterator G4TNtupleManager< NT, FT >::BeginConstNtuple ( ) const

protected

BeginNtuple()

template<typename NT , typename FT >

std::vector< NT * >::iterator G4TNtupleManager< NT, FT >::BeginNtuple ( )

protected

Clear()

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::Clear ( )

overrideprotectedvirtual

Implements G4VNtupleManager.

Reimplemented in G4RootNtupleManager.

Referenced by G4RootNtupleManager::Clear().

CreateNtuple()

template<typename NT , typename FT >

virtual G4int G4TNtupleManager< NT, FT >::CreateNtuple ( G4NtupleBooking *  ntupleBooking )

overrideprotectedvirtual

Implements G4BaseNtupleManager.

CreateNtuplesFromBooking()

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::CreateNtuplesFromBooking ( const std::vector< G4NtupleBooking * > &  ntupleBookings )

protectedvirtual

CreateTNtupleFromBooking()

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::CreateTNtupleFromBooking ( G4TNtupleDescription< NT, FT > *  ntupleDescription )

privatepure virtual

EndConstNtuple()

template<typename NT , typename FT >

std::vector< NT * >::const_iterator G4TNtupleManager< NT, FT >::EndConstNtuple ( ) const

protected

EndNtuple()

template<typename NT , typename FT >

std::vector< NT * >::iterator G4TNtupleManager< NT, FT >::EndNtuple ( )

protected

FillNtupleDColumn() [1/3]

template<typename NT , typename FT >

G4bool G4BaseNtupleManager::FillNtupleDColumn ( G4int  id, G4double  value  )

finalprotectedvirtual

Reimplemented from G4BaseNtupleManager.

Definition at line 57 of file G4BaseNtupleManager.cc.

{
  return FillNtupleDColumn(fFirstId, id, value);
}

FillNtupleDColumn() [2/3]

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::FillNtupleDColumn ( G4int  ntupleId, G4int  columnId, G4double  value  )

finalprotectedvirtual

Implements G4BaseNtupleManager.

FillNtupleDColumn() [3/3]

template<typename NT , typename FT >

virtual G4bool G4BaseNtupleManager::FillNtupleDColumn ( G4int  ntupleId, G4int  columnId, G4double  value  )

protectedvirtual

Implements G4BaseNtupleManager.

FillNtupleFColumn() [1/3]

template<typename NT , typename FT >

G4bool G4BaseNtupleManager::FillNtupleFColumn ( G4int  id, G4float  value  )

finalprotectedvirtual

Reimplemented from G4BaseNtupleManager.

Definition at line 56 of file G4BaseNtupleManager.cc.

{
  return FillNtupleFColumn(fFirstId, id, value);
}

FillNtupleFColumn() [2/3]

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::FillNtupleFColumn ( G4int  ntupleId, G4int  columnId, G4float  value  )

finalprotectedvirtual

Implements G4BaseNtupleManager.

FillNtupleFColumn() [3/3]

template<typename NT , typename FT >

virtual G4bool G4BaseNtupleManager::FillNtupleFColumn ( G4int  ntupleId, G4int  columnId, G4float  value  )

protectedvirtual

Implements G4BaseNtupleManager.

FillNtupleIColumn() [1/3]

template<typename NT , typename FT >

G4bool G4BaseNtupleManager::FillNtupleIColumn ( G4int  id, G4int  value  )

finalprotectedvirtual

Reimplemented from G4BaseNtupleManager.

Definition at line 55 of file G4BaseNtupleManager.cc.

{
  return FillNtupleIColumn(fFirstId, id, value);
}

FillNtupleIColumn() [2/3]

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::FillNtupleIColumn ( G4int  ntupleId, G4int  columnId, G4int  value  )

finalprotectedvirtual

Implements G4BaseNtupleManager.

FillNtupleIColumn() [3/3]

template<typename NT , typename FT >

virtual G4bool G4BaseNtupleManager::FillNtupleIColumn ( G4int  ntupleId, G4int  columnId, G4int  value  )

protectedvirtual

Implements G4BaseNtupleManager.

FillNtupleSColumn() [1/3]

template<typename NT , typename FT >

G4bool G4BaseNtupleManager::FillNtupleSColumn ( G4int  id, const G4String &  value  )

finalprotectedvirtual

Reimplemented from G4BaseNtupleManager.

Definition at line 58 of file G4BaseNtupleManager.cc.

{
  return FillNtupleSColumn(fFirstId, id, value);
}

FillNtupleSColumn() [2/3]

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::FillNtupleSColumn ( G4int  ntupleId, G4int  columnId, const G4String &  value  )

finalprotectedvirtual

Implements G4BaseNtupleManager.

FillNtupleSColumn() [3/3]

template<typename NT , typename FT >

virtual G4bool G4BaseNtupleManager::FillNtupleSColumn ( G4int  ntupleId, G4int  columnId, const G4String &  value  )

protectedvirtual

Implements G4BaseNtupleManager.

FillNtupleTColumn()

template<typename NT , typename FT >

template<typename T >

G4bool G4TNtupleManager< NT, FT >::FillNtupleTColumn ( G4int  ntupleId, G4int  columnId, const T &  value  )

private

FinishTNtuple()

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::FinishTNtuple ( G4TNtupleDescription< NT, FT > *  ntupleDescription, G4bool  fromBooking  )

privatepure virtual

GetActivation()

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::GetActivation ( G4int  ntupleId ) const

finalprotectedvirtual

Implements G4VNtupleManager.

GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References G4BaseAnalysisManager::fFirstId.

GetNofNtuples()

template<typename NT , typename FT >

virtual G4int G4TNtupleManager< NT, FT >::GetNofNtuples ( ) const

finalprotectedvirtual

Implements G4VNtupleManager.

GetNtuple() [1/2]

template<typename NT , typename FT >

NT * G4TNtupleManager< NT, FT >::GetNtuple ( ) const

protected

GetNtuple() [2/2]

template<typename NT , typename FT >

NT * G4TNtupleManager< NT, FT >::GetNtuple ( G4int  ntupleId ) const

protected

GetNtupleDescriptionInFunction()

template<typename NT , typename FT >

G4TNtupleDescription< NT, FT > * G4TNtupleManager< NT, FT >::GetNtupleDescriptionInFunction ( G4int  id, std::string_view  function, G4bool  warn = true  ) const

private

GetNtupleInFunction()

template<typename NT , typename FT >

NT * G4TNtupleManager< NT, FT >::GetNtupleInFunction ( G4int  id, std::string_view  function, G4bool  warn = true  ) const

private

IsVerbose()

G4bool G4BaseAnalysisManager::IsVerbose ( G4int  verboseLevel ) const

inlineprotectedinherited

Definition at line 80 of file G4BaseAnalysisManager.hh.

{ return fState.IsVerbose(verboseLevel); }

References G4BaseAnalysisManager::fState, and G4AnalysisManagerState::IsVerbose().

Referenced by G4RootPNtupleManager::AddNtupleRow(), and G4RootPNtupleManager::Merge().

Message()

void G4BaseAnalysisManager::Message ( G4int  level, const G4String &  action, const G4String &  objectType, const G4String &  objectName = "", G4bool  success = true  ) const

inlineprotectedinherited

Definition at line 83 of file G4BaseAnalysisManager.hh.

{
  fState.Message(level, action, objectType, objectName, success);
}

References geant4_check_module_cycles::action, G4BaseAnalysisManager::fState, and G4AnalysisManagerState::Message().

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootPNtupleManager::Clear(), G4NtupleBookingManager::ClearData(), G4RootMainNtupleManager::ClearData(), G4NtupleBookingManager::CreateNtuple(), G4RootMainNtupleManager::CreateNtuple(), G4RootPNtupleManager::CreateNtupleFromMain(), G4RootPNtupleManager::Merge(), G4CsvRNtupleManager::ReadNtupleImpl(), G4Hdf5RNtupleManager::ReadNtupleImpl(), G4RootRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::ReadNtupleImpl(), G4XmlRNtupleManager::SetNtupleDColumn(), G4XmlRNtupleManager::SetNtupleFColumn(), G4XmlRNtupleManager::SetNtupleIColumn(), and G4XmlRNtupleManager::SetNtupleSColumn().

Reset()

template<typename NT , typename FT >

virtual G4bool G4TNtupleManager< NT, FT >::Reset ( )

protectedvirtual

Reimplemented in G4RootNtupleManager.

Referenced by G4RootNtupleManager::Reset().

SetActivation() [1/2]

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::SetActivation ( G4bool  activation )

finalprotectedvirtual

Implements G4VNtupleManager.

SetActivation() [2/2]

template<typename NT , typename FT >

virtual void G4TNtupleManager< NT, FT >::SetActivation ( G4int  ntupleId, G4bool  activation  )

finalprotectedvirtual

Implements G4VNtupleManager.

SetFirstId()

G4bool G4BaseAnalysisManager::SetFirstId ( G4int  firstId )

inherited

Definition at line 46 of file G4BaseAnalysisManager.cc.

{
  if ( fLockFirstId ) {
    Warn("Cannot set FirstId as its value was already used.",
      fkClass, "SetFirstId");
 
    return false;
  }
 
  fFirstId = firstId;
  return true;
}

References G4BaseAnalysisManager::fFirstId, G4BaseAnalysisManager::fkClass, G4BaseAnalysisManager::fLockFirstId, and G4Analysis::Warn().

SetFirstNtupleColumnId()

G4bool G4BaseNtupleManager::SetFirstNtupleColumnId ( G4int  firstId )

finalprotectedvirtualinherited

Implements G4VNtupleManager.

Definition at line 67 of file G4BaseNtupleManager.cc.

{
  fFirstNtupleColumnId = firstId;
  return true;
}

SetLockFirstId()

void G4BaseAnalysisManager::SetLockFirstId ( G4bool  lockFirstId )

inlineinherited

Definition at line 90 of file G4BaseAnalysisManager.hh.

                                                                    {
  fLockFirstId = lockFirstId;
}

References G4BaseAnalysisManager::fLockFirstId.

Referenced by G4HnManager::ClearData().

Field Documentation

fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }

protectedinherited

Definition at line 70 of file G4BaseAnalysisManager.hh.

Referenced by G4BaseNtupleManager::AddNtupleRow(), G4NtupleBookingManager::CreateNtuple(), G4BaseNtupleManager::FillNtupleDColumn(), G4BaseNtupleManager::FillNtupleFColumn(), G4BaseNtupleManager::FillNtupleIColumn(), G4BaseRNtupleManager::GetCurrentNtupleId(), G4BaseAnalysisManager::GetFirstId(), G4HnManager::GetHnInformation(), G4RootPNtupleManager::GetMainNtupleInFunction(), G4NtupleBookingManager::GetNtupleBookingInFunction(), G4RootPNtupleManager::GetNtupleDescriptionInFunction(), G4BaseRNtupleManager::GetNtupleRow(), and G4BaseAnalysisManager::SetFirstId().

fFirstNtupleColumnId

G4int G4BaseNtupleManager::fFirstNtupleColumnId { 0 }

protectedinherited

Definition at line 73 of file G4BaseNtupleManager.hh.

fkClass

template<typename NT , typename FT >

constexpr std::string_view G4TNtupleManager< NT, FT >::fkClass { "G4TNtupleManager<NT,FT>" }

staticconstexprprivate

Definition at line 126 of file G4TNtupleManager.hh.

fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protectedinherited

Definition at line 71 of file G4BaseAnalysisManager.hh.

Referenced by G4NtupleBookingManager::CreateNtuple(), G4BaseAnalysisManager::SetFirstId(), and G4BaseAnalysisManager::SetLockFirstId().

fNtupleDescriptionVector

template<typename NT , typename FT >

std::vector<G4TNtupleDescription<NT, FT>*> G4TNtupleManager< NT, FT >::fNtupleDescriptionVector

protected

Definition at line 96 of file G4TNtupleManager.hh.

fNtupleVector

template<typename NT , typename FT >

std::vector<NT*> G4TNtupleManager< NT, FT >::fNtupleVector

protected

Definition at line 97 of file G4TNtupleManager.hh.

fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState

protectedinherited

Definition at line 69 of file G4BaseAnalysisManager.hh.

Referenced by G4RootPNtupleManager::AddNtupleRow(), G4RootNtupleManager::G4RootNtupleManager(), G4BaseAnalysisManager::IsVerbose(), and G4BaseAnalysisManager::Message().

---

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

• source/analysis/management/include/G4TNtupleManager.hh