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