G4BaseAnalysisManager Class Reference

#include <G4BaseAnalysisManager.hh>

Inheritance diagram for G4BaseAnalysisManager:

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

Protected Member Functions
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Protected Attributes
G4int	fFirstId { 0 }
G4bool	fLockFirstId { false }
const G4AnalysisManagerState &	fState

Static Private Attributes
static constexpr std::string_view	fkClass { "G4BaseAnalysisManager" }

Detailed Description

Definition at line 43 of file G4BaseAnalysisManager.hh.

Constructor & Destructor Documentation

G4BaseAnalysisManager() [1/2]

G4BaseAnalysisManager::G4BaseAnalysisManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 36 of file G4BaseAnalysisManager.cc.

  : fState(state)
{}

G4BaseAnalysisManager() [2/2]

G4BaseAnalysisManager::G4BaseAnalysisManager ( )

delete

~G4BaseAnalysisManager()

virtual G4BaseAnalysisManager::~G4BaseAnalysisManager ( )

virtualdefault

Member Function Documentation

GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inline

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References fFirstId.

IsVerbose()

G4bool G4BaseAnalysisManager::IsVerbose ( G4int  verboseLevel ) const

inlineprotected

Definition at line 80 of file G4BaseAnalysisManager.hh.

{ return fState.IsVerbose(verboseLevel); }

References 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

inlineprotected

Definition at line 83 of file G4BaseAnalysisManager.hh.

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

References geant4_check_module_cycles::action, 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().

SetFirstId()

G4bool G4BaseAnalysisManager::SetFirstId

(

G4int

firstId

)

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 fFirstId, fkClass, fLockFirstId, and G4Analysis::Warn().

SetLockFirstId()

void G4BaseAnalysisManager::SetLockFirstId ( G4bool  lockFirstId )

inline

Definition at line 90 of file G4BaseAnalysisManager.hh.

                                                                    {
  fLockFirstId = lockFirstId;
}

References fLockFirstId.

Referenced by G4HnManager::ClearData().

Field Documentation

fFirstId

G4int G4BaseAnalysisManager::fFirstId { 0 }

protected

Definition at line 70 of file G4BaseAnalysisManager.hh.

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

fkClass

constexpr std::string_view G4BaseAnalysisManager::fkClass { "G4BaseAnalysisManager" }

staticconstexprprivate

Definition at line 75 of file G4BaseAnalysisManager.hh.

Referenced by SetFirstId().

fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protected

Definition at line 71 of file G4BaseAnalysisManager.hh.

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

fState

const G4AnalysisManagerState& G4BaseAnalysisManager::fState

protected

Definition at line 69 of file G4BaseAnalysisManager.hh.

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

---

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

• source/analysis/management/include/G4BaseAnalysisManager.hh
• source/analysis/management/src/G4BaseAnalysisManager.cc