G4HnManager Class Reference

#include <G4HnManager.hh>

Inheritance diagram for G4HnManager:

Public Member Functions
	G4HnManager (G4String hnType, const G4AnalysisManagerState &state)
	G4HnManager ()=delete
	~G4HnManager () override
void	CreateMessenger ()
void	AddHnInformation (G4HnInformation *info)
void	AddHnInformation (G4HnInformation *info, G4int index)
void	SetHnDeleted (G4HnInformation *info, G4bool keepSetting)
void	ClearData ()
G4HnInformation *	GetHnInformation (G4int id, std::string_view functionName, G4bool warn=true) const
G4HnDimensionInformation *	GetHnDimensionInformation (G4int id, G4int dimension, std::string_view functionName, G4bool warn=true) const
const std::vector< G4HnInformation * > &	GetHnVector () const
G4int	GetNofActiveHns () const
G4String	GetHnType () const
G4bool	IsActive () const
G4bool	IsAscii () const
G4bool	IsPlotting () const
G4bool	IsFileName () const
void	SetActivation (G4bool activation)
void	SetActivation (G4int id, G4bool activation)
void	SetAscii (G4int id, G4bool ascii)
void	SetPlotting (G4int id, G4bool plotting)
void	SetPlotting (G4bool plotting)
void	SetFileName (G4int id, const G4String &fileName)
void	SetFileName (const G4String &fileName)
G4bool	SetAxisIsLog (unsigned int idim, G4int id, G4bool isLogAxis)
G4String	GetName (G4int id) const
G4double	GetUnit (unsigned int idim, G4int id) const
G4bool	GetAxisIsLog (unsigned int idim, G4int id) const
G4bool	GetActivation (G4int id) const
G4bool	GetAscii (G4int id) const
G4bool	GetPlotting (G4int id) const
G4String	GetFileName (G4int id) const
void	SetFileManager (std::shared_ptr< G4VFileManager > fileManager)
void	SetDefaultFileType (const G4String &fileType)
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
	G4BaseAnalysisManager ()=delete
virtual	~G4BaseAnalysisManager ()=default
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () const
G4int	GetCycle () const

Additional Inherited Members
Protected Member Functions inherited from G4BaseAnalysisManager
G4bool	IsVerbose (G4int verboseLevel) const
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const
Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState
G4int	fFirstId { 0 }
G4bool	fLockFirstId { false }

Detailed Description

Definition at line 48 of file G4HnManager.hh.

Constructor & Destructor Documentation

G4HnManager() [1/2]

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

Definition at line 41 of file G4HnManager.cc.

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

G4HnManager() [2/2]

G4HnManager::G4HnManager ( )

delete

~G4HnManager()

G4HnManager::~G4HnManager ( )

override

Definition at line 46 of file G4HnManager.cc.

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

Member Function Documentation

AddHnInformation() [1/2]

void G4HnManager::AddHnInformation

(

G4HnInformation *

info

)

Definition at line 144 of file G4HnManager.cc.

{
  // Add new information
 
  fHnVector.push_back(info);
  ++fNofActiveObjects;
}

AddHnInformation() [2/2]

void G4HnManager::AddHnInformation	(	G4HnInformation *	info,
		G4int	index )

Definition at line 153 of file G4HnManager.cc.

{
  // Replace the information at 'index' position with new one.
  // Update new information with the previous one settings if the
  // previous histogram was deleted with 'keepSetting' set true.
 
  auto previousInfo = fHnVector[index];
  if (previousInfo->GetDeletedPair().second) {
    info->Update(*previousInfo);
  }
  delete previousInfo;
 
  fHnVector[index] = info;
 
  if (info->GetActivation()) { ++fNofActiveObjects; }
  if (info->GetAscii())      { ++fNofAsciiObjects; }
  if (info->GetPlotting())   { ++fNofPlottingObjects; }
  if (! info->GetFileName().empty()) { ++fNofFileNameObjects; }
}

ClearData()

void G4HnManager::ClearData

(

)

Definition at line 185 of file G4HnManager.cc.

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

CreateMessenger()

void G4HnManager::CreateMessenger

(

)

Definition at line 138 of file G4HnManager.cc.

{
  fMessenger = std::make_unique<G4HnMessenger>(*this);
}

GetActivation()

G4bool G4HnManager::GetActivation

(

G4int

id

)

const

Definition at line 372 of file G4HnManager.cc.

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

GetAscii()

G4bool G4HnManager::GetAscii

(

G4int

id

)

const

Definition at line 382 of file G4HnManager.cc.

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

GetAxisIsLog()

G4bool G4HnManager::GetAxisIsLog	(	unsigned int	idim,
		G4int	id ) const

Definition at line 362 of file G4HnManager.cc.

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

GetFileName()

G4String G4HnManager::GetFileName

(

G4int

id

)

const

Definition at line 402 of file G4HnManager.cc.

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

GetHnDimensionInformation()

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

Definition at line 210 of file G4HnManager.cc.

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

Referenced by GetUnit().

GetHnInformation()

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

Definition at line 195 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];
}

Referenced by GetActivation(), GetAscii(), GetAxisIsLog(), GetFileName(), GetHnDimensionInformation(), GetName(), GetPlotting(), SetActivation(), SetAscii(), SetAxisIsLog(), SetFileName(), and SetPlotting().

GetHnType()

G4String G4HnManager::GetHnType ( ) const

inline

Definition at line 152 of file G4HnManager.hh.

{ return fHnType; }

GetHnVector()

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

inline

Definition at line 155 of file G4HnManager.hh.

{ return fHnVector; }

GetName()

G4String G4HnManager::GetName

(

G4int

id

)

const

Definition at line 342 of file G4HnManager.cc.

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

GetNofActiveHns()

G4int G4HnManager::GetNofActiveHns ( ) const

inline

Definition at line 149 of file G4HnManager.hh.

{ return fNofActiveObjects; }

GetPlotting()

G4bool G4HnManager::GetPlotting

(

G4int

id

)

const

Definition at line 392 of file G4HnManager.cc.

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

GetUnit()

G4double G4HnManager::GetUnit	(	unsigned int	idim,
		G4int	id ) const

Definition at line 352 of file G4HnManager.cc.

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

IsActive()

G4bool G4HnManager::IsActive

(

)

const

Definition at line 221 of file G4HnManager.cc.

{
  return ( fNofActiveObjects > 0 );
}

IsAscii()

G4bool G4HnManager::IsAscii

(

)

const

Definition at line 227 of file G4HnManager.cc.

{
  return ( fNofAsciiObjects > 0 );
}

IsFileName()

G4bool G4HnManager::IsFileName

(

)

const

Definition at line 239 of file G4HnManager.cc.

{
  return ( fNofFileNameObjects > 0 );
}

IsPlotting()

G4bool G4HnManager::IsPlotting

(

)

const

Definition at line 233 of file G4HnManager.cc.

{
  return ( fNofPlottingObjects > 0 );
}

SetActivation() [1/2]

void G4HnManager::SetActivation

(

G4bool

activation

)

Definition at line 257 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);
  }
}

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

SetActivation() [2/2]

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

Definition at line 245 of file G4HnManager.cc.

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

SetAscii()

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

Definition at line 271 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetAscii");
 
  if (info == nullptr) 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--;
  }
}

Referenced by G4HnMessenger::SetNewValue().

SetAxisIsLog()

G4bool G4HnManager::SetAxisIsLog	(	unsigned int	idim,
		G4int	id,
		G4bool	isLogAxis )

Definition at line 331 of file G4HnManager.cc.

{
  auto info = GetHnInformation(id, "SetAxisIsLog");
 
  if (info == nullptr) return false;
 
  info->SetIsLogAxis(idim, isLog);
  return true;
}

Referenced by G4HnMessenger::SetNewValue().

SetDefaultFileType()

void G4HnManager::SetDefaultFileType ( const G4String & fileType )

inline

Definition at line 163 of file G4HnManager.hh.

{
  fDefaultFileType = fileType;
}

SetFileManager()

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

inline

Definition at line 158 of file G4HnManager.hh.

{
  fFileManager = std::move(fileManager);
}

SetFileName() [1/2]

void G4HnManager::SetFileName

(

const G4String &

fileName

)

Definition at line 321 of file G4HnManager.cc.

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

SetFileName() [2/2]

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

Definition at line 311 of file G4HnManager.cc.

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

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

SetHnDeleted()

void G4HnManager::SetHnDeleted	(	G4HnInformation *	info,
		G4bool	keepSetting )

Definition at line 174 of file G4HnManager.cc.

{
  info->SetDeleted(true, keepSetting);
 
  if (info->GetActivation()) { --fNofActiveObjects; }
  if (info->GetAscii())      { --fNofAsciiObjects; }
  if (info->GetPlotting())   { --fNofPlottingObjects; }
  if (! info->GetFileName().empty()) { --fNofFileNameObjects; }
}

SetPlotting() [1/2]

void G4HnManager::SetPlotting

(

G4bool

plotting

)

Definition at line 301 of file G4HnManager.cc.

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

SetPlotting() [2/2]

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

Definition at line 291 of file G4HnManager.cc.

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

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

---

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

• G4HnManager.hh
• G4HnManager.cc