Geant4  10.01.p03
G4TrialsCounter.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: $
28 // GEANT4 tag $Name: $
29 //
30 //
31 // class G4TrialsCounter
32 //
33 // Class description:
34 // Keep statistics of the number of trials,
35 // including the Maximum and how many times it was reached.
36 //
37 
38 // Author: Dec 8, 2006 John Apostolakis
39 // -------------------------------------------------------------------
40 #ifndef G4TRIALS_COUNTER_HH
41 #define G4TRIALS_COUNTER_HH
42 
43 #include "G4Types.hh"
44 #include "G4String.hh"
45 
47 {
48  public: // with description
49 
50  G4TrialsCounter( const G4String& nameStats,
51  const G4String& description, G4bool printOnExit=false );
53 
54  inline void AccumulateCounts( G4int noTrials );
55  // Add this number to stats
56  void ClearCounts();
57  // Reset all counts
58  G4int ReturnTotals( G4int& calls, G4int& maxTrials, G4int& numMaxT ) ;
59  // Return number of count/trials, calls, max & no-max
60 
61  void PrintStatistics();
62 
63  private:
64 
65  G4int fTotalNoTrials; // Counts sum of trials
66  G4int fNumberCalls; // Total # of calls to accumulate
67  G4int fmaxTrials; // Max value of trials
68  G4int fNoTimesMaxTrials; // How many times maximum is reached
69 
70  G4String fName; // Identifies stats, and is printed
71  G4String fDescription; // Explanation of stats
72  G4bool fStatsVerbose; // If verbose and not printed, print on destruction
73  G4bool fPrinted; // Flag, to avoid reprinting on destruction
74 };
75 
76 #include "G4TrialsCounter.icc"
77 
78 #endif /* End of ifndef G4TRIALS_COUNTER_HH */
G4TrialsCounter(const G4String &nameStats, const G4String &description, G4bool printOnExit=false)
G4int ReturnTotals(G4int &calls, G4int &maxTrials, G4int &numMaxT)
int G4int
Definition: G4Types.hh:78
void AccumulateCounts(G4int noTrials)
bool G4bool
Definition: G4Types.hh:79