G4HnManager Class Reference

#include <G4HnManager.hh>

Inheritance diagram for G4HnManager:

Public Member Functions
G4HnInformation *	AddHnInformation (const G4String &name, G4int nofDimensions)
void	ClearData ()
	G4HnManager ()=delete
	G4HnManager (const G4String &hnType, const G4AnalysisManagerState &state)
G4bool	GetActivation (G4int id) const
G4bool	GetAscii (G4int id) const
G4String	GetFileName (G4int id) const
G4int	GetFirstId () const
G4HnDimensionInformation *	GetHnDimensionInformation (G4int id, G4int dimension, std::string_view functionName, G4bool warn=true) const
G4HnInformation *	GetHnInformation (G4int id, std::string_view functionName, G4bool warn=true) const
G4String	GetHnType () const
const std::vector< G4HnInformation * > &	GetHnVector () const
G4String	GetName (G4int id) const
G4int	GetNofHns () const
G4bool	GetPlotting (G4int id) const
G4bool	GetXAxisIsLog (G4int id) const
G4double	GetXUnit (G4int id) const
G4bool	GetYAxisIsLog (G4int id) const
G4double	GetYUnit (G4int id) const
G4bool	GetZAxisIsLog (G4int id) const
G4double	GetZUnit (G4int id) const
G4bool	IsActive () const
G4bool	IsAscii () const
G4bool	IsFileName () const
G4bool	IsPlotting () const
void	SetActivation (G4bool activation)
void	SetActivation (G4int id, G4bool activation)
void	SetAscii (G4int id, G4bool ascii)
void	SetFileManager (std::shared_ptr< G4VFileManager > fileManager)
void	SetFileName (const G4String &fileName)
void	SetFileName (G4int id, const G4String &fileName)
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
void	SetPlotting (G4bool plotting)
void	SetPlotting (G4int id, G4bool plotting)
G4bool	SetXAxisIsLog (G4int id, G4bool isLogAxis)
G4bool	SetYAxisIsLog (G4int id, G4bool isLogAxis)
G4bool	SetZAxisIsLog (G4int id, G4bool isLogAxis)
virtual	~G4HnManager ()

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

Private Member Functions
void	SetActivation (G4HnInformation *info, G4bool activation)
void	SetFileName (G4HnInformation *info, const G4String &fileName)
void	SetPlotting (G4HnInformation *info, G4bool plotting)

Private Attributes
std::shared_ptr< G4VFileManager >	fFileManager { nullptr }
G4String	fHnType
std::vector< G4HnInformation * >	fHnVector
G4int	fNofActiveObjects { 0 }
G4int	fNofAsciiObjects { 0 }
G4int	fNofFileNameObjects { 0 }
G4int	fNofPlottingObjects { 0 }

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

Detailed Description

Definition at line 45 of file G4HnManager.hh.

Constructor & Destructor Documentation

G4HnManager() [1/2]

G4HnManager::G4HnManager	(	const G4String &	hnType,
		const G4AnalysisManagerState &	state
	)

Definition at line 37 of file G4HnManager.cc.

  : G4BaseAnalysisManager(state),
    fHnType(hnType)
{}

G4HnManager() [2/2]

G4HnManager::G4HnManager ( )

delete

~G4HnManager()

G4HnManager::~G4HnManager ( )

virtual

Definition at line 44 of file G4HnManager.cc.

{
  for ( auto info : fHnVector ) {
    delete info;
  }
}

References fHnVector.

Member Function Documentation

AddHnInformation()

G4HnInformation * G4HnManager::AddHnInformation	(	const G4String &	name,
		G4int	nofDimensions
	)

Definition at line 114 of file G4HnManager.cc.

{
  auto info = new G4HnInformation(name, nofDimensions);
  fHnVector.push_back(info);
  ++fNofActiveObjects;
 
  return info;
}

References fHnVector, fNofActiveObjects, and G4InuclParticleNames::name().

ClearData()

void G4HnManager::ClearData

(

)

Definition at line 124 of file G4HnManager.cc.

{
  for ( auto info : fHnVector ) {
    delete info;
  }
  fHnVector.clear();
  SetLockFirstId(false);
}

References fHnVector, and G4BaseAnalysisManager::SetLockFirstId().

GetActivation()

G4bool G4HnManager::GetActivation

(

G4int

id

)

const

Definition at line 371 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetActivation");
 
  if ( ! info ) return true;
 
  return info->GetActivation();
}

References GetHnInformation().

GetAscii()

G4bool G4HnManager::GetAscii

(

G4int

id

)

const

Definition at line 381 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetAscii");
 
  if ( ! info ) return false;
 
  return info->GetAscii();
}

References GetHnInformation().

GetFileName()

G4String G4HnManager::GetFileName

(

G4int

id

)

const

Definition at line 401 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetFileName");
 
  if ( ! info ) return "";
 
  return info->GetFileName();
}

References GetHnInformation().

GetFirstId()

G4int G4BaseAnalysisManager::GetFirstId ( ) const

inlineinherited

Definition at line 94 of file G4BaseAnalysisManager.hh.

                                                     {
  return fFirstId;
}

References G4BaseAnalysisManager::fFirstId.

GetHnDimensionInformation()

G4HnDimensionInformation * G4HnManager::GetHnDimensionInformation	(	G4int	id,
		G4int	dimension,
		std::string_view	functionName,
		G4bool	warn = true
	)		const

Definition at line 149 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, functionName, warn);
  if ( ! info ) return nullptr;
 
  return info->GetHnDimensionInformation(dimension);
}

References GetHnInformation().

Referenced by GetXUnit(), GetYUnit(), and GetZUnit().

GetHnInformation()

G4HnInformation * G4HnManager::GetHnInformation	(	G4int	id,
		std::string_view	functionName,
		G4bool	warn = true
	)		const

Definition at line 134 of file G4HnManager.cc.

{
  G4int index = id - fFirstId;
  if ( index < 0 || index >= G4int(fHnVector.size()) ) {
    if ( warn ) {
      Warn(fHnType + " histogram " + to_string(id) + " does not exist.",
        fkClass, functionName);
    }
    return nullptr;
  }
  return fHnVector[index];
}

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

Referenced by GetActivation(), GetAscii(), GetFileName(), GetHnDimensionInformation(), GetName(), GetPlotting(), GetXAxisIsLog(), GetYAxisIsLog(), GetZAxisIsLog(), SetActivation(), SetAscii(), SetFileName(), SetPlotting(), SetXAxisIsLog(), SetYAxisIsLog(), and SetZAxisIsLog().

GetHnType()

G4String G4HnManager::GetHnType ( ) const

inline

Definition at line 147 of file G4HnManager.hh.

{ return fHnType; }

References fHnType.

Referenced by G4HnMessenger::G4HnMessenger().

GetHnVector()

const std::vector< G4HnInformation * > & G4HnManager::GetHnVector ( ) const

inline

Definition at line 150 of file G4HnManager.hh.

{ return fHnVector; }

References fHnVector.

GetName()

G4String G4HnManager::GetName

(

G4int

id

)

const

Definition at line 301 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetName");
 
  if ( ! info ) return "";
 
  return info->GetName();
}

References GetHnInformation().

GetNofHns()

G4int G4HnManager::GetNofHns ( ) const

inline

Definition at line 144 of file G4HnManager.hh.

{ return G4int(fHnVector.size()); }

References fHnVector.

GetPlotting()

G4bool G4HnManager::GetPlotting

(

G4int

id

)

const

Definition at line 391 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetPlotting");
 
  if ( ! info ) return false;
 
  return info->GetPlotting();
}

References GetHnInformation().

GetXAxisIsLog()

G4bool G4HnManager::GetXAxisIsLog

(

G4int

id

)

const

Definition at line 341 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetXAxisIsLog");
 
  if ( ! info ) return false;
 
  return info->GetIsLogAxis(kX);
}

References GetHnInformation(), and G4Analysis::kX.

GetXUnit()

G4double G4HnManager::GetXUnit

(

G4int

id

)

const

Definition at line 311 of file G4HnManager.cc.

{
  auto info = GetHnDimensionInformation(id, kX, "GetXUnit");
 
  if ( ! info ) return 1.0;
 
  return info->fUnit;
}

References GetHnDimensionInformation(), and G4Analysis::kX.

GetYAxisIsLog()

G4bool G4HnManager::GetYAxisIsLog

(

G4int

id

)

const

Definition at line 351 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetYAxisIsLog");
 
  if ( ! info ) return 1.0;
 
  return info->GetIsLogAxis(kY);
}

References GetHnInformation(), and G4Analysis::kY.

GetYUnit()

G4double G4HnManager::GetYUnit

(

G4int

id

)

const

Definition at line 321 of file G4HnManager.cc.

{
  auto info = GetHnDimensionInformation(id, kY, "GetYUnit");
 
  if ( ! info ) return 1.0;
 
  return info->fUnit;
}

References GetHnDimensionInformation(), and G4Analysis::kY.

GetZAxisIsLog()

G4bool G4HnManager::GetZAxisIsLog

(

G4int

id

)

const

Definition at line 361 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "GetZAxisIsLog");
 
  if ( ! info ) return 1.0;
 
  return info->GetIsLogAxis(kZ);
}

References GetHnInformation(), and G4Analysis::kZ.

GetZUnit()

G4double G4HnManager::GetZUnit

(

G4int

id

)

const

Definition at line 331 of file G4HnManager.cc.

{
  auto info = GetHnDimensionInformation(id, kZ, "GetZUnit");
 
  if ( ! info ) return 1.0;
 
  return info->fUnit;
}

References GetHnDimensionInformation(), and G4Analysis::kZ.

IsActive()

G4bool G4HnManager::IsActive

(

)

const

Definition at line 160 of file G4HnManager.cc.

{
  return ( fNofActiveObjects > 0 );
}

References fNofActiveObjects.

IsAscii()

G4bool G4HnManager::IsAscii

(

)

const

Definition at line 166 of file G4HnManager.cc.

{
  return ( fNofAsciiObjects > 0 );
}

References fNofAsciiObjects.

IsFileName()

G4bool G4HnManager::IsFileName

(

)

const

Definition at line 178 of file G4HnManager.cc.

{
  return ( fNofFileNameObjects > 0 );
}

References fNofFileNameObjects.

IsPlotting()

G4bool G4HnManager::IsPlotting

(

)

const

Definition at line 172 of file G4HnManager.cc.

{
  return ( fNofPlottingObjects > 0 );
}

References fNofPlottingObjects.

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().

SetActivation() [1/3]

void G4HnManager::SetActivation

(

G4bool

activation

)

Definition at line 196 of file G4HnManager.cc.

{
// Set activation to all objects of the given type
 
  //std::vector<G4HnInformation*>::iterator it;
  //for ( it = fHnVector.begin(); it != fHnVector.end(); it++ ) {
  //   G4HnInformation* info = *it;
 
  for ( auto info : fHnVector )  {
    SetActivation(info, activation);
  }
}

References fHnVector, and SetActivation().

Referenced by SetActivation(), and G4HnMessenger::SetNewValue().

SetActivation() [2/3]

void G4HnManager::SetActivation ( G4HnInformation *  info, G4bool  activation  )

private

Definition at line 56 of file G4HnManager.cc.

{
// Set activation to a given object
 
  // Do nothing if activation does not change
  if ( info->GetActivation() == activation ) return;
 
  // Change activation and account it in fNofActiveObjects
  info->SetActivation(activation);
  if ( activation )
    fNofActiveObjects++;
  else
    fNofActiveObjects--;
}

References fNofActiveObjects, G4HnInformation::GetActivation(), and G4HnInformation::SetActivation().

SetActivation() [3/3]

void G4HnManager::SetActivation	(	G4int	id,
		G4bool	activation
	)

Definition at line 184 of file G4HnManager.cc.

{
// Set activation to a given object
 
  auto info = GetHnInformation(id, "SetActivation");
 
  if ( ! info ) return;
 
  SetActivation(info, activation);
}

References GetHnInformation(), and SetActivation().

SetAscii()

void G4HnManager::SetAscii	(	G4int	id,
		G4bool	ascii
	)

Definition at line 210 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetAscii");
 
  if ( ! info ) return;
 
  // Do nothing if ascii does not change
  if ( info->GetAscii() == ascii ) return;
 
  // Change ascii and account it in fNofAsciiObjects
  info->SetAscii(ascii);
  if ( ascii )
    fNofAsciiObjects++;
  else
    fNofAsciiObjects--;
}

References fNofAsciiObjects, and GetHnInformation().

Referenced by G4HnMessenger::SetNewValue().

SetFileManager()

void G4HnManager::SetFileManager ( std::shared_ptr< G4VFileManager >  fileManager )

inline

Definition at line 153 of file G4HnManager.hh.

{ fFileManager = fileManager; }

References fFileManager.

SetFileName() [1/3]

void G4HnManager::SetFileName

(

const G4String &

fileName

)

Definition at line 258 of file G4HnManager.cc.

{
// Set plotting to all objects of the given type
 
  for ( auto info : fHnVector )  {
    SetFileName(info, fileName);
  }
}

References fHnVector, and SetFileName().

SetFileName() [2/3]

void G4HnManager::SetFileName ( G4HnInformation *  info, const G4String &  fileName  )

private

Definition at line 86 of file G4HnManager.cc.

{
  // Do nothing if file name does not change
  if ( info->GetFileName() == fileName ) return;
 
  // Save the info and account a new file name if file manager
  info->SetFileName(fileName);
  if (fFileManager) {
    fFileManager->AddFileName(fileName);
  } else {
    Warn("Failed to set fileName " + fileName +
         " for object " + info->GetName() + ".\nFile manager is not set.",
         fkClass, "SetFileName");
    return;
  }
 
  if ( fileName != "" ) {
    fNofFileNameObjects++;
  } else {
    fNofFileNameObjects--;
  }
}

References fFileManager, fkClass, fNofFileNameObjects, G4HnInformation::GetFileName(), G4HnInformation::GetName(), G4HnInformation::SetFileName(), and G4Analysis::Warn().

SetFileName() [3/3]

void G4HnManager::SetFileName	(	G4int	id,
		const G4String &	fileName
	)

Definition at line 248 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetFileName");
 
  if ( ! info ) return;
 
  SetFileName(info, fileName);
}

References GetHnInformation(), and SetFileName().

Referenced by SetFileName(), and G4HnMessenger::SetNewValue().

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().

SetLockFirstId()

void G4BaseAnalysisManager::SetLockFirstId ( G4bool  lockFirstId )

inlineinherited

Definition at line 90 of file G4BaseAnalysisManager.hh.

                                                                    {
  fLockFirstId = lockFirstId;
}

References G4BaseAnalysisManager::fLockFirstId.

Referenced by ClearData().

SetPlotting() [1/3]

void G4HnManager::SetPlotting

(

G4bool

plotting

)

Definition at line 238 of file G4HnManager.cc.

{
// Set plotting to all objects of the given type
 
  for ( auto info : fHnVector )  {
    SetPlotting(info, plotting);
  }
}

References fHnVector, and SetPlotting().

SetPlotting() [2/3]

void G4HnManager::SetPlotting ( G4HnInformation *  info, G4bool  plotting  )

private

Definition at line 72 of file G4HnManager.cc.

{
  // Do nothing if ascii does not change
  if ( info->GetPlotting() == plotting ) return;
 
  // Change Plotting and account it in fNofPlottingObjects
  info->SetPlotting(plotting);
  if ( plotting )
    fNofPlottingObjects++;
  else
    fNofPlottingObjects--;
}

References fNofPlottingObjects, G4HnInformation::GetPlotting(), and G4HnInformation::SetPlotting().

SetPlotting() [3/3]

void G4HnManager::SetPlotting	(	G4int	id,
		G4bool	plotting
	)

Definition at line 228 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetPlotting");
 
  if ( ! info ) return;
 
  SetPlotting(info, plotting);
}

References GetHnInformation(), and SetPlotting().

Referenced by G4HnMessenger::SetNewValue(), and SetPlotting().

SetXAxisIsLog()

G4bool G4HnManager::SetXAxisIsLog	(	G4int	id,
		G4bool	isLogAxis
	)

Definition at line 268 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetXAxisIsLog");
 
  if ( ! info ) return false;
 
  info->SetIsLogAxis(kX, isLog);
  return true;
}

References GetHnInformation(), and G4Analysis::kX.

SetYAxisIsLog()

G4bool G4HnManager::SetYAxisIsLog	(	G4int	id,
		G4bool	isLogAxis
	)

Definition at line 279 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetYAxisIsLog");
 
  if ( ! info ) return false;
 
  info->SetIsLogAxis(kY, isLog);
  return true;
}

References GetHnInformation(), and G4Analysis::kY.

SetZAxisIsLog()

G4bool G4HnManager::SetZAxisIsLog	(	G4int	id,
		G4bool	isLogAxis
	)

Definition at line 290 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetZAxisIsLog");
 
  if ( ! info ) return false;
 
  info->SetIsLogAxis(kZ, isLog);
  return true;
}

References GetHnInformation(), and G4Analysis::kZ.

Field Documentation

fFileManager

std::shared_ptr<G4VFileManager> G4HnManager::fFileManager { nullptr }

private

Definition at line 141 of file G4HnManager.hh.

Referenced by SetFileManager(), and SetFileName().

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(), GetHnInformation(), G4RootPNtupleManager::GetMainNtupleInFunction(), G4NtupleBookingManager::GetNtupleBookingInFunction(), G4RootPNtupleManager::GetNtupleDescriptionInFunction(), G4BaseRNtupleManager::GetNtupleRow(), and G4BaseAnalysisManager::SetFirstId().

fHnType

G4String G4HnManager::fHnType

private

Definition at line 133 of file G4HnManager.hh.

Referenced by GetHnInformation(), and GetHnType().

fHnVector

std::vector<G4HnInformation*> G4HnManager::fHnVector

private

Definition at line 140 of file G4HnManager.hh.

Referenced by AddHnInformation(), ClearData(), GetHnInformation(), GetHnVector(), GetNofHns(), SetActivation(), SetFileName(), SetPlotting(), and ~G4HnManager().

fkClass

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

staticconstexprprivate

Definition at line 130 of file G4HnManager.hh.

Referenced by GetHnInformation(), and SetFileName().

fLockFirstId

G4bool G4BaseAnalysisManager::fLockFirstId { false }

protectedinherited

Definition at line 71 of file G4BaseAnalysisManager.hh.

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

fNofActiveObjects

G4int G4HnManager::fNofActiveObjects { 0 }

private

Definition at line 134 of file G4HnManager.hh.

Referenced by AddHnInformation(), IsActive(), and SetActivation().

fNofAsciiObjects

G4int G4HnManager::fNofAsciiObjects { 0 }

private

Definition at line 135 of file G4HnManager.hh.

Referenced by IsAscii(), and SetAscii().

fNofFileNameObjects

G4int G4HnManager::fNofFileNameObjects { 0 }

private

Definition at line 137 of file G4HnManager.hh.

Referenced by IsFileName(), and SetFileName().

fNofPlottingObjects

G4int G4HnManager::fNofPlottingObjects { 0 }

private

Definition at line 136 of file G4HnManager.hh.

Referenced by IsPlotting(), and SetPlotting().

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 files:

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