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