summaryrefslogtreecommitdiff
path: root/inc/OSD_Chronometer.hxx
blob: 842571757ec7ef2042ae47d392c13872445e7482 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _OSD_Chronometer_HeaderFile
#define _OSD_Chronometer_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif


//! This class measures CPU time (both user and system) consumed <br>
//!          by current process or thread. The chronometer can be started <br>
//!          and stopped multiple times, and measures cumulative time. <br>
class OSD_Chronometer  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Initializes a stopped Chronometer. <br>
  Standard_EXPORT   OSD_Chronometer(const Standard_Boolean ThisThreadOnly = Standard_False);
  
  Standard_EXPORT   virtual  void Destroy() ;
~OSD_Chronometer()
{
  Destroy();
}
  //! Stops and Reinitializes the Chronometer. <br>
  Standard_EXPORT   virtual  void Reset() ;
  //! Stops the Chronometer. <br>
  Standard_EXPORT   virtual  void Stop() ;
  //! Starts (after Create or Reset) or restarts (after Stop) <br>
//!          the chronometer. <br>
  Standard_EXPORT   virtual  void Start() ;
  //! Shows the current CPU user and system time on the <br>
//!          standard output stream <cout>. <br>
//!          The chronometer can be running (laps Time) or stopped. <br>
  Standard_EXPORT   virtual  void Show() ;
  //! Shows the current CPU user and system time on the output <br>
//!          stream <os>. <br>
//!          The chronometer can be running (laps Time) or stopped. <br>
  Standard_EXPORT   virtual  void Show(Standard_OStream& os) ;
  //! Returns the current CPU user time in a variable. <br>
//!          The chronometer can be running (laps Time) or stopped. <br>
  Standard_EXPORT     void Show(Standard_Real& UserSeconds) ;
  //! Returns the current CPU user and system time in variables. <br>
//!          The chronometer can be running (laps Time) or stopped. <br>
  Standard_EXPORT     void Show(Standard_Real& UserSeconds,Standard_Real& SystemSeconds) ;
  //! Returns CPU time (user and system) consumed by the current <br>
//!          process since its start, in seconds. The actual precision of <br>
//!          the measurement depends on granularity provided by the system, <br>
//!          and is platform-specific. <br>
  Standard_EXPORT   static  void GetProcessCPU(Standard_Real& UserSeconds,Standard_Real& SystemSeconds) ;
  //! Returns CPU time (user and system) consumed by the current <br>
//!          thread since its start. Note that this measurement is <br>
//!          platform-specific, as threads are implemented and managed <br>
//!          differently on different platforms and CPUs. <br>
  Standard_EXPORT   static  void GetThreadCPU(Standard_Real& UserSeconds,Standard_Real& SystemSeconds) ;





protected:



Standard_Boolean Stopped;


private:



Standard_Boolean ThreadOnly;
Standard_Real Start_user;
Standard_Real Start_sys;
Standard_Real Cumul_user;
Standard_Real Cumul_sys;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif