G4HnManager Class Reference

#include <G4HnManager.hh>

Inheritance diagram for G4HnManager:

Public Member Functions
	G4HnManager (const G4String &hnType, const G4AnalysisManagerState &state)
virtual	~G4HnManager ()
G4HnInformation *	AddHnInformation (const G4String &name, G4int nofDimensions)
G4HnInformation *	GetHnInformation (G4int id, G4String functionName="", G4bool warn=true) const
G4HnDimensionInformation *	GetHnDimensionInformation (G4int id, G4int dimension, G4String functionName="", G4bool warn=true) const
const std::vector< G4HnInformation * > &	GetHnVector () const
G4int	GetNofHns () 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	SetXAxisIsLog (G4int id, G4bool isLogAxis)
G4bool	SetYAxisIsLog (G4int id, G4bool isLogAxis)
G4bool	SetZAxisIsLog (G4int id, G4bool isLogAxis)
G4String	GetName (G4int id) const
G4double	GetXUnit (G4int id) const
G4double	GetYUnit (G4int id) const
G4double	GetZUnit (G4int id) const
G4bool	GetXAxisIsLog (G4int id) const
G4bool	GetYAxisIsLog (G4int id) const
G4bool	GetZAxisIsLog (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)
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
virtual	~G4BaseAnalysisManager ()
G4bool	SetFirstId (G4int firstId)
void	SetLockFirstId (G4bool lockFirstId)
G4int	GetFirstId () const

Additional Inherited Members
Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState
G4int	fFirstId
G4bool	fLockFirstId

Detailed Description

Definition at line 44 of file G4HnManager.hh.

Constructor & Destructor Documentation

G4HnManager()

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

Definition at line 36 of file G4HnManager.cc.

  : G4BaseAnalysisManager(state),
    fHnType(hnType),
    fNofActiveObjects(0),
    fNofAsciiObjects(0),
    fNofPlottingObjects(0),
    fNofFileNameObjects(0),
    fHnVector(),
    fFileManager(nullptr)
{
}

~G4HnManager()

G4HnManager::~G4HnManager ( )

virtual

Definition at line 50 of file G4HnManager.cc.

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

Member Function Documentation

AddHnInformation()

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

Definition at line 123 of file G4HnManager.cc.

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

GetActivation()

G4bool G4HnManager::GetActivation

(

G4int

id

)

const

Definition at line 377 of file G4HnManager.cc.

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

GetAscii()

G4bool G4HnManager::GetAscii

(

G4int

id

)

const

Definition at line 387 of file G4HnManager.cc.

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

GetFileName()

G4String G4HnManager::GetFileName

(

G4int

id

)

const

Definition at line 407 of file G4HnManager.cc.

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

GetHnDimensionInformation()

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

Definition at line 155 of file G4HnManager.cc.

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

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

GetHnInformation()

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

Definition at line 133 of file G4HnManager.cc.

{
  G4int index = id - fFirstId;
  if ( index < 0 || index >= G4int(fHnVector.size()) ) {
    if ( warn ) {
      G4String inFunction = "G4HnManager::";
      if ( functionName.size() )
        inFunction += functionName;
      else
        inFunction += "GetHnInformation"; 
      G4ExceptionDescription description;
      description << "      " << fHnType << " histogram " << id 
                  << " does not exist.";
      G4Exception(inFunction, "Analysis_W011", JustWarning, description);
    }  
    return nullptr;         
  }
  return fHnVector[index];
}    

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 140 of file G4HnManager.hh.

{ return fHnType; }

Referenced by G4HnMessenger::G4HnMessenger().

GetHnVector()

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

inline

Definition at line 143 of file G4HnManager.hh.

{ return fHnVector; }

GetName()

G4String G4HnManager::GetName

(

G4int

id

)

const

Definition at line 307 of file G4HnManager.cc.

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

GetNofHns()

G4int G4HnManager::GetNofHns ( ) const

inline

Definition at line 137 of file G4HnManager.hh.

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

GetPlotting()

G4bool G4HnManager::GetPlotting

(

G4int

id

)

const

Definition at line 397 of file G4HnManager.cc.

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

GetXAxisIsLog()

G4bool G4HnManager::GetXAxisIsLog

(

G4int

id

)

const

Definition at line 347 of file G4HnManager.cc.

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

GetXUnit()

G4double G4HnManager::GetXUnit

(

G4int

id

)

const

Definition at line 317 of file G4HnManager.cc.

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

GetYAxisIsLog()

G4bool G4HnManager::GetYAxisIsLog

(

G4int

id

)

const

Definition at line 357 of file G4HnManager.cc.

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

GetYUnit()

G4double G4HnManager::GetYUnit

(

G4int

id

)

const

Definition at line 327 of file G4HnManager.cc.

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

GetZAxisIsLog()

G4bool G4HnManager::GetZAxisIsLog

(

G4int

id

)

const

Definition at line 367 of file G4HnManager.cc.

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

GetZUnit()

G4double G4HnManager::GetZUnit

(

G4int

id

)

const

Definition at line 337 of file G4HnManager.cc.

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

IsActive()

G4bool G4HnManager::IsActive

(

)

const

Definition at line 166 of file G4HnManager.cc.

{
  return ( fNofActiveObjects > 0 );
}  

IsAscii()

G4bool G4HnManager::IsAscii

(

)

const

Definition at line 172 of file G4HnManager.cc.

{
  return ( fNofAsciiObjects > 0 );
}  

IsFileName()

G4bool G4HnManager::IsFileName

(

)

const

Definition at line 184 of file G4HnManager.cc.

{
  return ( fNofFileNameObjects > 0 );
}

IsPlotting()

G4bool G4HnManager::IsPlotting

(

)

const

Definition at line 178 of file G4HnManager.cc.

{
  return ( fNofPlottingObjects > 0 );
}  

SetActivation() [1/2]

void G4HnManager::SetActivation

(

G4bool

activation

)

Definition at line 202 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(), and G4HnMessenger::SetNewValue().

SetActivation() [2/2]

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

Definition at line 190 of file G4HnManager.cc.

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

SetAscii()

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

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

Referenced by G4HnMessenger::SetNewValue().

SetFileManager()

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

inline

Definition at line 146 of file G4HnManager.hh.

{ fFileManager = fileManager; }

SetFileName() [1/2]

void G4HnManager::SetFileName

(

const G4String &

fileName

)

Definition at line 264 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 254 of file G4HnManager.cc.

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

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

SetPlotting() [1/2]

void G4HnManager::SetPlotting

(

G4bool

plotting

)

Definition at line 244 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 234 of file G4HnManager.cc.

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

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

SetXAxisIsLog()

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

Definition at line 274 of file G4HnManager.cc.

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

SetYAxisIsLog()

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

Definition at line 285 of file G4HnManager.cc.

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

SetZAxisIsLog()

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

Definition at line 296 of file G4HnManager.cc.

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

---

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

• G4HnManager.hh
• G4HnManager.cc