[833] | 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: G4Timer.hh,v 1.14 2006/06/29 19:03:15 gunter Exp $ |
---|
| 28 | // GEANT4 tag $Name: $ |
---|
| 29 | // |
---|
| 30 | // |
---|
| 31 | // ---------------------------------------------------------------------- |
---|
| 32 | // Class G4Timer |
---|
| 33 | // |
---|
| 34 | // Class description: |
---|
| 35 | // |
---|
| 36 | // Class for timer objects, able to measure elasped user/system process time. |
---|
| 37 | // |
---|
| 38 | // Note: Uses <sys/times.h> & <unistd.h> - POSIX.1 defined |
---|
| 39 | // If used, this header must be included in the source (.cc) file and it |
---|
| 40 | // must be the first header file to be included! |
---|
| 41 | // |
---|
| 42 | // Member functions: |
---|
| 43 | // |
---|
| 44 | // G4Timer() |
---|
| 45 | // Construct a timer object |
---|
| 46 | // Start() |
---|
| 47 | // Start timing |
---|
| 48 | // Stop() |
---|
| 49 | // Stop timing |
---|
| 50 | // G4bool IsValid() |
---|
| 51 | // Return true if have a valid time (ie start() and stop() called) |
---|
| 52 | // G4double GetRealElapsed() |
---|
| 53 | // Return the elapsed real time between last calling start() and stop() |
---|
| 54 | // G4double GetSystemElapsed() |
---|
| 55 | // Return the elapsed system time between last calling start() and stop() |
---|
| 56 | // G4double GetUserElapsed() |
---|
| 57 | // Return the elapsed user time between last calling start() and stop() |
---|
| 58 | // |
---|
| 59 | // Operators: |
---|
| 60 | // |
---|
| 61 | // std::ostream& operator << (std::ostream& os, const G4Timer& t); |
---|
| 62 | // Print the elapsed real,system and usertimes on os. Prints **s for times |
---|
| 63 | // if !IsValid |
---|
| 64 | // |
---|
| 65 | // Member data: |
---|
| 66 | // |
---|
| 67 | // G4bool fValidTimes |
---|
| 68 | // True after start and stop have both been called more than once and |
---|
| 69 | // an equal number of times |
---|
| 70 | // clock_t fStartRealTime,fEndRealTime |
---|
| 71 | // Real times (arbitrary time 0) |
---|
| 72 | // tms fStartTimes,fEndTimes |
---|
| 73 | // Timing structures (see times(2)) for start and end times |
---|
| 74 | |
---|
| 75 | // History: |
---|
| 76 | // 23.08.96 P.Kent Updated to also computed real elapsed time |
---|
| 77 | // 21.08.95 P.Kent |
---|
| 78 | // 29.04.97 G.Cosmo Added timings for Windows/NT |
---|
| 79 | |
---|
| 80 | #ifndef G4TIMER_HH |
---|
| 81 | #define G4TIMER_HH |
---|
| 82 | |
---|
| 83 | #ifndef WIN32 |
---|
| 84 | # include <unistd.h> |
---|
| 85 | # include <sys/times.h> |
---|
| 86 | #else |
---|
| 87 | # include <time.h> |
---|
| 88 | # define _SC_CLK_TCK 1 |
---|
| 89 | |
---|
| 90 | extern "C" { |
---|
| 91 | int sysconf(int); |
---|
| 92 | }; |
---|
| 93 | |
---|
| 94 | // Structure returned by times() |
---|
| 95 | |
---|
| 96 | struct tms { |
---|
| 97 | clock_t tms_utime; /* user time */ |
---|
| 98 | clock_t tms_stime; /* system time */ |
---|
| 99 | clock_t tms_cutime; /* user time, children */ |
---|
| 100 | clock_t tms_cstime; /* system time, children */ |
---|
| 101 | }; |
---|
| 102 | |
---|
| 103 | extern "C" { |
---|
| 104 | extern clock_t times(struct tms *); |
---|
| 105 | }; |
---|
| 106 | #endif /* WIN32 */ |
---|
| 107 | |
---|
| 108 | #include "G4Types.hh" |
---|
| 109 | #include "G4ios.hh" |
---|
| 110 | |
---|
| 111 | class G4Timer |
---|
| 112 | { |
---|
| 113 | public: |
---|
| 114 | |
---|
| 115 | G4Timer(); |
---|
| 116 | |
---|
| 117 | inline void Start(); |
---|
| 118 | inline void Stop(); |
---|
| 119 | inline G4bool IsValid() const; |
---|
| 120 | G4double GetRealElapsed() const; |
---|
| 121 | G4double GetSystemElapsed() const; |
---|
| 122 | G4double GetUserElapsed() const; |
---|
| 123 | |
---|
| 124 | private: |
---|
| 125 | |
---|
| 126 | G4bool fValidTimes; |
---|
| 127 | clock_t fStartRealTime,fEndRealTime; |
---|
| 128 | tms fStartTimes,fEndTimes; |
---|
| 129 | }; |
---|
| 130 | |
---|
| 131 | std::ostream& operator << (std::ostream& os, const G4Timer& t); |
---|
| 132 | |
---|
| 133 | #include "G4Timer.icc" |
---|
| 134 | |
---|
| 135 | #define times ostimes |
---|
| 136 | |
---|
| 137 | #endif |
---|