G4TrialsCounter.hh

Go to the documentation of this file.
00001 //
00002 // ********************************************************************
00003 // * License and Disclaimer                                           *
00004 // *                                                                  *
00005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
00006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
00007 // * conditions of the Geant4 Software License,  included in the file *
00008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
00009 // * include a list of copyright holders.                             *
00010 // *                                                                  *
00011 // * Neither the authors of this software system, nor their employing *
00012 // * institutes,nor the agencies providing financial support for this *
00013 // * work  make  any representation or  warranty, express or implied, *
00014 // * regarding  this  software system or assume any liability for its *
00015 // * use.  Please see the license in the file  LICENSE  and URL above *
00016 // * for the full disclaimer and the limitation of liability.         *
00017 // *                                                                  *
00018 // * This  code  implementation is the result of  the  scientific and *
00019 // * technical work of the GEANT4 collaboration.                      *
00020 // * By using,  copying,  modifying or  distributing the software (or *
00021 // * any work based  on the software)  you  agree  to acknowledge its *
00022 // * use  in  resulting  scientific  publications,  and indicate your *
00023 // * acceptance of all terms of the Geant4 Software license.          *
00024 // ********************************************************************
00025 //
00026 //
00027 // $Id: $
00028 // GEANT4 tag $Name:  $
00029 //
00030 //
00031 // class G4TrialsCounter
00032 //
00033 // Class description:
00034 //    Keep statistics of the number of trials,
00035 //    including the Maximum and how many times it was reached.
00036 //
00037 
00038 // Author: Dec 8, 2006  John Apostolakis    
00039 // -------------------------------------------------------------------
00040 #ifndef G4TRIALS_COUNTER_HH
00041 #define G4TRIALS_COUNTER_HH
00042 
00043 #include "G4Types.hh"
00044 #include "G4String.hh"
00045 
00046 class  G4TrialsCounter
00047 {
00048   public:  // with description
00049 
00050     G4TrialsCounter( const G4String& nameStats,
00051                      const G4String& description, G4bool printOnExit=false ); 
00052    ~G4TrialsCounter();
00053 
00054     inline void AccumulateCounts( G4int noTrials ); 
00055        //  Add this number to stats
00056     void ClearCounts(); 
00057        //  Reset all counts
00058     G4int ReturnTotals( G4int& calls, G4int& maxTrials, G4int& numMaxT ) ; 
00059        //  Return number of count/trials, calls, max & no-max
00060 
00061     void PrintStatistics(); 
00062 
00063   private:
00064 
00065     G4int    fTotalNoTrials;    //  Counts sum of trials 
00066     G4int    fNumberCalls;      //  Total # of calls to accumulate
00067     G4int    fmaxTrials;        // Max value of trials
00068     G4int    fNoTimesMaxTrials; // How many times maximum is reached
00069 
00070     G4String  fName;         //  Identifies stats, and is printed 
00071     G4String  fDescription;  //  Explanation of stats
00072     G4bool    fStatsVerbose; //  If verbose and not printed, print on destruction
00073     G4bool    fPrinted;      //  Flag, to avoid reprinting on destruction
00074 }; 
00075 
00076 #include "G4TrialsCounter.icc"
00077 
00078 #endif  /* End of ifndef G4TRIALS_COUNTER_HH */

Generated on Mon May 27 17:50:03 2013 for Geant4 by  doxygen 1.4.7