include/Geant4/G4TrialsCounter.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4TrialsCounter
0027 //
0028 // Class description:
0029 //
0030 // Keeps statistics of the number of trials, including the Maximum
0031 // and how many times it was reached.
0032
0033 // Author: John Apostolakis, CERN - 08.12.2006
0034 // -------------------------------------------------------------------
0035 #ifndef G4TRIALS_COUNTER_HH
0036 #define G4TRIALS_COUNTER_HH
0037
0038 #include "G4Types.hh"
0039 #include "G4String.hh"
0040
0041 class  G4TrialsCounter
0042 {
0043   public:  // with description
0044
0045     G4TrialsCounter( const G4String& nameStats,
0046                      const G4String& description, G4bool printOnExit = false );
0047    ~G4TrialsCounter();
0048
0049     inline void AccumulateCounts( G4int noTrials );
0050        //  Add this number to stats
0051     void ClearCounts();
0052        //  Reset all counts
0053     G4int ReturnTotals( G4int& calls, G4int& maxTrials, G4int& numMaxT ) ;
0054        //  Return number of count/trials, calls, max & no-max
0055
0056     void PrintStatistics();
0057
0058   private:
0059
0060     G4int fTotalNoTrials = 0;    //  Counts sum of trials
0061     G4int fNumberCalls = 0;      //  Total # of calls to accumulate
0062     G4int fmaxTrials = 0;        // Max value of trials
0063     G4int fNoTimesMaxTrials = 0; // How many times maximum is reached
0064
0065     G4String fName;        //  Identifies stats, and is printed
0066     G4String fDescription; //  Explanation of stats
0067
0068     G4bool fStatsVerbose = false;
0069       // If verbose and not printed, print on destruction
0070     G4bool fPrinted = false;
0071       // Flag, to avoid reprinting on destruction
0072 };
0073
0074 #include "G4TrialsCounter.icc"
0075
0076 #endif  /* End of ifndef G4TRIALS_COUNTER_HH */