G4TrialsCounter Class Reference

G4TrialsCounter is a class to keep statistics of the number of trials, including the maximum and how many times it was reached. More...

#include <G4TrialsCounter.hh>

Public Member Functions
	G4TrialsCounter (const G4String &nameStats, const G4String &description, G4bool printOnExit=false)
	~G4TrialsCounter ()
void	AccumulateCounts (G4int noTrials)
void	ClearCounts ()
G4int	ReturnTotals (G4int &calls, G4int &maxTrials, G4int &numMaxT)
void	PrintStatistics ()

Detailed Description

G4TrialsCounter is a class to keep statistics of the number of trials, including the maximum and how many times it was reached.

Definition at line 46 of file G4TrialsCounter.hh.

Constructor & Destructor Documentation

G4TrialsCounter()

G4TrialsCounter::G4TrialsCounter	(	const G4String &	nameStats,
		const G4String &	description,
		G4bool	printOnExit = false )

Constructor for G4TrialsCounter.

Parameters

[in]	nameStats	Identifier.
[in]	description	Description text.
[in]	printOnExit	Flag for enabling additional verbosity on exit.

Definition at line 34 of file G4TrialsCounter.cc.

  : fName(nameStats), fDescription(description), fStatsVerbose(printOnExit) 
{ 
  ClearCounts(); 
}

~G4TrialsCounter()

G4TrialsCounter::~G4TrialsCounter

(

)

Destructor.

Definition at line 42 of file G4TrialsCounter.cc.

{ 
  if( (fStatsVerbose) && (!fPrinted) )  { PrintStatistics(); }
}

Member Function Documentation

AccumulateCounts()

void G4TrialsCounter::AccumulateCounts ( G4int noTrials )

inline

Adds this number to stats.

ClearCounts()

void G4TrialsCounter::ClearCounts

(

)

Resets all counts.

Definition at line 63 of file G4TrialsCounter.cc.

{
  fTotalNoTrials = 0; 
  fNumberCalls   = 0; 
  fmaxTrials     = 0;        // Maximum --> so only unsigned ints expected
  fNoTimesMaxTrials = 0; 
}

Referenced by G4TrialsCounter().

PrintStatistics()

void G4TrialsCounter::PrintStatistics

(

)

Prints out statistics.

Definition at line 48 of file G4TrialsCounter.cc.

{
  // Print Statistics
  //
  G4cout << "G4TrialsCounter::PrintStatistics()" << G4endl
         << "Report of counts for " << fDescription  << " : " << G4endl;
  G4cout << "Stats for '" <<  fName << "' > "
         << "  No-trials= " << fTotalNoTrials
         << "  No-calls= "  << fNumberCalls
         << "  Max-trial= " << fmaxTrials
         << "  no-max= "    << fNoTimesMaxTrials 
         << G4endl; 
  fPrinted = true; 
}

Referenced by ~G4TrialsCounter().

ReturnTotals()

G4int G4TrialsCounter::ReturnTotals	(	G4int &	calls,
		G4int &	maxTrials,
		G4int &	numMaxT )

Returns number of count/trials, calls, max & no-max.

Definition at line 72 of file G4TrialsCounter.cc.

{
  calls     = fNumberCalls; 
  maxTrials = fmaxTrials;
  numMaxT   = fNoTimesMaxTrials; 
 
  return fTotalNoTrials; 
}

---

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

• G4TrialsCounter.hh
• G4TrialsCounter.cc