| Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of
>> 2 // the GEANT4 collaboration.
1 // 3 //
2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work
3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement,
4 // * << 6 // and all its terms.
5 // * The Geant4 software is copyright of th << 7 //
6 // * the Geant4 Collaboration. It is provided << 8 // $Id: G4Timer.hh,v 1.10 2000/01/06 14:27:09 gcosmo Exp $
7 // * conditions of the Geant4 Software License << 9 // GEANT4 tag $Name: geant4-03-00 $
8 // * LICENSE and available at http://cern.ch/ << 10 //
9 // * include a list of copyright holders. << 11 //
10 // * << 12 // ----------------------------------------------------------------------
11 // * Neither the authors of this software syst << 13 // Class G4Timer
12 // * institutes,nor the agencies providing fin <<
13 // * work make any representation or warran <<
14 // * regarding this software system or assum <<
15 // * use. Please see the license in the file <<
16 // * for the full disclaimer and the limitatio <<
17 // * <<
18 // * This code implementation is the result <<
19 // * technical work of the GEANT4 collaboratio <<
20 // * By using, copying, modifying or distri <<
21 // * any work based on the software) you ag <<
22 // * use in resulting scientific publicati <<
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* <<
25 // <<
26 // G4Timer <<
27 // 14 //
28 // Class description: 15 // Class description:
29 // 16 //
30 // Class for timer objects, able to measure el 17 // Class for timer objects, able to measure elasped user/system process time.
31 // 18 //
32 // Note: Uses <sys/times.h> & <unistd.h> - POS 19 // Note: Uses <sys/times.h> & <unistd.h> - POSIX.1 defined
33 // If used, this header must be included 20 // If used, this header must be included in the source (.cc) file and it
34 // must be the first header file to be i 21 // must be the first header file to be included!
35 // 22 //
36 // Member functions: 23 // Member functions:
37 // 24 //
38 // G4Timer() 25 // G4Timer()
39 // Construct a timer object 26 // Construct a timer object
40 // Start() 27 // Start()
41 // Start timing 28 // Start timing
42 // Stop() 29 // Stop()
43 // Stop timing 30 // Stop timing
44 // G4bool IsValid() 31 // G4bool IsValid()
45 // Return true if have a valid time (ie star 32 // Return true if have a valid time (ie start() and stop() called)
46 // G4double GetRealElapsed() 33 // G4double GetRealElapsed()
47 // Return the elapsed real time between last 34 // Return the elapsed real time between last calling start() and stop()
48 // G4double GetSystemElapsed() 35 // G4double GetSystemElapsed()
49 // Return the elapsed system time between la 36 // Return the elapsed system time between last calling start() and stop()
50 // G4double GetUserElapsed() 37 // G4double GetUserElapsed()
51 // Return the elapsed user time between last 38 // Return the elapsed user time between last calling start() and stop()
52 // 39 //
53 // Operators: 40 // Operators:
54 // 41 //
55 // std::ostream& operator << (std::ostream& os << 42 // G4std::ostream& operator << (G4std::ostream& os, const G4Timer& t);
56 // Print the elapsed real,system and usertim 43 // Print the elapsed real,system and usertimes on os. Prints **s for times
57 // if !IsValid 44 // if !IsValid
58 // 45 //
59 // Member data: 46 // Member data:
60 // 47 //
61 // G4bool fValidTimes 48 // G4bool fValidTimes
62 // True after start and stop have both been 49 // True after start and stop have both been called more than once and
63 // an equal number of times 50 // an equal number of times
64 // clock_t fStartRealTime,fEndRealTime 51 // clock_t fStartRealTime,fEndRealTime
65 // Real times (arbitrary time 0) 52 // Real times (arbitrary time 0)
66 // tms fStartTimes,fEndTimes 53 // tms fStartTimes,fEndTimes
67 // Timing structures (see times(2)) for star 54 // Timing structures (see times(2)) for start and end times
68 55
69 // Author: P.Kent, 21.08.95 - First implementa << 56 // History:
70 // Revision: G.Cosmo, 29.04.97 - Added timings << 57 // 23.08.96 P.Kent Updated to also computed real elapsed time
71 // ------------------------------------------- << 58 // 21.08.95 P.Kent
>> 59 // 29.04.97 G.Cosmo Added timings for Windows/NT
>> 60
72 #ifndef G4TIMER_HH 61 #ifndef G4TIMER_HH
73 #define G4TIMER_HH 1 << 62 #define G4TIMER_HH
74 63
75 #if !(defined(WIN32) || defined(__MINGW32__)) << 64 #ifndef WIN32
76 # include <sys/times.h> <<
77 # include <unistd.h> 65 # include <unistd.h>
>> 66 # include <sys/times.h>
78 #else 67 #else
79 # include <time.h> 68 # include <time.h>
80 # define _SC_CLK_TCK 1 << 69 # define _SC_CLK_TCK 1
81 70
82 extern "C" << 71 extern "C" {
83 { << 72 int sysconf(int);
84 int sysconf(int); << 73 };
85 }; << 74
>> 75 // Structure returned by times()
>> 76
>> 77 struct tms {
>> 78 clock_t tms_utime; /* user time */
>> 79 clock_t tms_stime; /* system time */
>> 80 clock_t tms_cutime; /* user time, children */
>> 81 clock_t tms_cstime; /* system time, children */
>> 82 };
>> 83
>> 84 extern "C" {
>> 85 extern clock_t times(struct tms *);
>> 86 };
>> 87 #endif /* WIN32 */
86 88
87 // Structure returned by times() << 89 #include "G4Types.hh"
>> 90 #include "G4ios.hh"
88 91
89 struct tms << 92 class G4Timer
90 { 93 {
91 clock_t tms_utime; /* user time */ << 94 public:
92 clock_t tms_stime; /* system time */ << 95 G4Timer() : fValidTimes(false) {;}
93 clock_t tms_cutime; /* user time, children * <<
94 clock_t tms_cstime; /* system time, children <<
95 }; <<
96 96
97 extern "C" << 97 inline void Start();
98 { << 98 inline void Stop();
99 extern clock_t times(struct tms*); << 99 inline G4bool IsValid() const;
>> 100 G4double GetRealElapsed() const;
>> 101 G4double GetSystemElapsed() const;
>> 102 G4double GetUserElapsed() const;
>> 103 private:
>> 104 G4bool fValidTimes;
>> 105 clock_t fStartRealTime,fEndRealTime;
>> 106 tms fStartTimes,fEndTimes;
100 }; 107 };
101 #endif /* WIN32 */ <<
102 108
103 #include "G4Types.hh" << 109 G4std::ostream& operator << (G4std::ostream& os, const G4Timer& t);
104 #include "G4ios.hh" <<
105 110
106 #include <chrono> << 111 // Inline functions:
107 112
108 class G4Timer << 113 inline void G4Timer::Start()
109 { 114 {
110 public: << 115 fValidTimes=false;
111 inline void Start(); << 116 fStartRealTime=times(&fStartTimes);
112 inline void Stop(); << 117 }
113 inline G4bool IsValid() const; <<
114 inline const char* GetClockTime() const; <<
115 G4double GetRealElapsed() const; <<
116 G4double GetSystemElapsed() const; <<
117 G4double GetUserElapsed() const; <<
118 <<
119 private: <<
120 G4bool fValidTimes{false}; <<
121 using clock_type = std::chrono::high_resolut <<
122 std::chrono::time_point<clock_type> fStartRe <<
123 tms fStartTimes, fEndTimes; <<
124 }; <<
125 118
126 std::ostream& operator<<(std::ostream& os, con << 119 inline void G4Timer::Stop()
>> 120 {
>> 121 fEndRealTime=times(&fEndTimes);
>> 122 fValidTimes=true;
>> 123 }
>> 124
>> 125 inline G4bool G4Timer::IsValid() const
>> 126 {
>> 127 return fValidTimes;
>> 128 }
127 129
128 #include "G4Timer.icc" << 130 #define times ostimes
129 131
130 #endif 132 #endif
>> 133
131 134