ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4TrialsCounter.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4TrialsCounter.hh
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 // G4TrialsCounter
27 //
28 // Class description:
29 //
30 // Keeps statistics of the number of trials, including the Maximum
31 // and how many times it was reached.
32 
33 // Author: John Apostolakis, CERN - 08.12.2006
34 // -------------------------------------------------------------------
35 #ifndef G4TRIALS_COUNTER_HH
36 #define G4TRIALS_COUNTER_HH
37 
38 #include "G4Types.hh"
39 #include "G4String.hh"
40 
42 {
43  public: // with description
44 
45  G4TrialsCounter( const G4String& nameStats,
46  const G4String& description, G4bool printOnExit = false );
48 
49  inline void AccumulateCounts( G4int noTrials );
50  // Add this number to stats
51  void ClearCounts();
52  // Reset all counts
53  G4int ReturnTotals( G4int& calls, G4int& maxTrials, G4int& numMaxT ) ;
54  // Return number of count/trials, calls, max & no-max
55 
56  void PrintStatistics();
57 
58  private:
59 
60  G4int fTotalNoTrials = 0; // Counts sum of trials
61  G4int fNumberCalls = 0; // Total # of calls to accumulate
62  G4int fmaxTrials = 0; // Max value of trials
63  G4int fNoTimesMaxTrials = 0; // How many times maximum is reached
64 
65  G4String fName; // Identifies stats, and is printed
66  G4String fDescription; // Explanation of stats
67 
69  // If verbose and not printed, print on destruction
70  G4bool fPrinted = false;
71  // Flag, to avoid reprinting on destruction
72 };
73 
74 #include "G4TrialsCounter.icc"
75 
76 #endif /* End of ifndef G4TRIALS_COUNTER_HH */