<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: dox/Common/vtkTimerLog.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>dox/Common/vtkTimerLog.h</h1><a href="a02145.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Program: Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: vtkTimerLog.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment"> All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment"> See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment"> PURPOSE. See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef __vtkTimerLog_h</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define __vtkTimerLog_h</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="preprocessor">#ifdef _WIN32</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#ifndef _WIN32_WCE</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#include <sys/types.h></span> <span class="comment">// Needed for Win32 implementation of timer</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <sys/timeb.h></span> <span class="comment">// Needed for Win32 implementation of timer</span>
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#include <time.h></span> <span class="comment">// Needed for unix implementation of timer</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <sys/time.h></span> <span class="comment">// Needed for unix implementation of timer</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include <sys/types.h></span> <span class="comment">// Needed for unix implementation of timer</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include <sys/times.h></span> <span class="comment">// Needed for unix implementation of timer</span>
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="comment">// var args</span>
<a name="l00048"></a>00048 <span class="preprocessor">#ifndef _WIN32</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#include <unistd.h></span> <span class="comment">// Needed for unix implementation of timer</span>
<a name="l00050"></a>00050 <span class="preprocessor">#endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052 <span class="comment">// select stuff here is for sleep method</span>
<a name="l00053"></a>00053 <span class="preprocessor">#ifndef NO_FD_SET</span>
<a name="l00054"></a><a class="code" href="a02145.html#9e292c3c6a1d1f547c67d31c218ead31">00054</a> <span class="preprocessor"></span><span class="preprocessor"># define SELECT_MASK fd_set</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor"># ifndef _AIX</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span> <span class="keyword">typedef</span> <span class="keywordtype">long</span> fd_mask;
<a name="l00058"></a>00058 <span class="preprocessor"># endif</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor"># if defined(_IBMR2)</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor"># define SELECT_MASK void</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor"># else</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor"># define SELECT_MASK int</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor"># endif</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span>
<a name="l00066"></a>00066
<a name="l00067"></a><a class="code" href="a02145.html#9e66906964f05add5b33526d20352e0d">00067</a> <span class="preprocessor">#define VTK_LOG_EVENT_LENGTH 40</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
<a name="l00069"></a>00069 <span class="comment">//BTX</span>
<a name="l00070"></a><a class="code" href="a01716.html">00070</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00071"></a>00071 {
<a name="l00072"></a><a class="code" href="a01716.html#19787d8cd4c0570868f3573c09f3a742">00072</a> <span class="keywordtype">double</span> WallTime;
<a name="l00073"></a><a class="code" href="a01716.html#2ba2d0a5b224018c434e9d7e27ab6e57">00073</a> <span class="keywordtype">int</span> CpuTicks;
<a name="l00074"></a><a class="code" href="a01716.html#84d73cb4435f6a4b58fcf977d6358111">00074</a> <span class="keywordtype">char</span> Event[<a class="code" href="a02145.html#9e66906964f05add5b33526d20352e0d">VTK_LOG_EVENT_LENGTH</a>];
<a name="l00075"></a><a class="code" href="a01716.html#0e506cd4c0fc9c079daca88dc9054280">00075</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Indent;
<a name="l00076"></a>00076 } <a class="code" href="a01716.html">vtkTimerLogEntry</a>;
<a name="l00077"></a>00077 <span class="comment">//ETX</span>
<a name="l00078"></a>00078
<a name="l00079"></a><a class="code" href="a01715.html">00079</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <span class="keyword">public</span>:
<a name="l00082"></a>00082 <span class="keyword">static</span> <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a> *<a class="code" href="a01084.html#4d5b227267c076d6f9e38483370b6612">New</a>();
<a name="l00083"></a>00083
<a name="l00084"></a><a class="code" href="a01715.html#55357431272d07081e27730dfb8be765">00084</a> vtkTypeRevisionMacro(<a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>,<a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>);
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00086"></a>00086
<a name="l00088"></a>00088
<a name="l00090"></a><a class="code" href="a01715.html#a229a3063bfac403c0239a44f46f3d5e">00090</a> <span class="keyword">static</span> <span class="keywordtype">void</span> SetLogging(<span class="keywordtype">int</span> v) {<a class="code" href="a01715.html#15158c1cc7862eb6087bddfc7a663235">vtkTimerLog::Logging</a> = v;}
<a name="l00091"></a><a class="code" href="a01715.html#a4b2602c2ce897857fbc3351cfe15f46">00091</a> <span class="keyword">static</span> <span class="keywordtype">int</span> GetLogging() {<span class="keywordflow">return</span> <a class="code" href="a01715.html#15158c1cc7862eb6087bddfc7a663235">vtkTimerLog::Logging</a>;}
<a name="l00092"></a><a class="code" href="a01715.html#b12de75e0ae4dd9d78567dbc473c43c5">00092</a> <span class="keyword">static</span> <span class="keywordtype">void</span> LoggingOn() {<a class="code" href="a01715.html#a229a3063bfac403c0239a44f46f3d5e">vtkTimerLog::SetLogging</a>(1);}
<a name="l00093"></a><a class="code" href="a01715.html#f767e4d136304786fcaefce3a0b749ff">00093</a> <span class="keyword">static</span> <span class="keywordtype">void</span> LoggingOff() {<a class="code" href="a01715.html#a229a3063bfac403c0239a44f46f3d5e">vtkTimerLog::SetLogging</a>(0);}
<a name="l00095"></a>00095
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">static</span> <span class="keywordtype">void</span> SetMaxEntries(<span class="keywordtype">int</span> a);
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keywordtype">int</span> GetMaxEntries();
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment">//BTX</span>
<a name="l00105"></a>00105 <span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">void</span> FormatAndMarkEvent(<span class="keyword">const</span> <span class="keywordtype">char</span> *EventString, ...);
<a name="l00106"></a>00106 <span class="comment">//ETX</span>
<a name="l00107"></a>00107
<a name="l00110"></a>00110 <span class="keyword">static</span> <span class="keywordtype">void</span> DumpLog(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename);
<a name="l00111"></a>00111
<a name="l00113"></a>00113
<a name="l00116"></a>00116 <span class="keyword">static</span> <span class="keywordtype">void</span> MarkStartEvent(<span class="keyword">const</span> <span class="keywordtype">char</span> *EventString);
<a name="l00117"></a>00117 <span class="keyword">static</span> <span class="keywordtype">void</span> MarkEndEvent(<span class="keyword">const</span> <span class="keywordtype">char</span> *EventString);
<a name="l00119"></a>00119 <span class="comment">//BTX</span>
<a name="l00120"></a>00120 <span class="keyword">static</span> <span class="keywordtype">void</span> DumpLogWithIndents(ostream *os, <span class="keywordtype">double</span> threshold);
<a name="l00121"></a>00121 <span class="comment">//ETX</span>
<a name="l00122"></a>00122
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keyword">static</span> <span class="keywordtype">int</span> GetNumberOfEvents();
<a name="l00126"></a>00126 <span class="keyword">static</span> <span class="keywordtype">int</span> GetEventIndent(<span class="keywordtype">int</span> i);
<a name="l00127"></a>00127 <span class="keyword">static</span> <span class="keywordtype">double</span> GetEventWallTime(<span class="keywordtype">int</span> i);
<a name="l00128"></a>00128 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetEventString(<span class="keywordtype">int</span> i);
<a name="l00130"></a>00130
<a name="l00132"></a>00132 <span class="keyword">static</span> <span class="keywordtype">void</span> MarkEvent(<span class="keyword">const</span> <span class="keywordtype">char</span> *EventString);
<a name="l00133"></a>00133
<a name="l00136"></a>00136 <span class="keyword">static</span> <span class="keywordtype">void</span> ResetLog();
<a name="l00137"></a>00137
<a name="l00139"></a>00139 <span class="keyword">static</span> <span class="keywordtype">void</span> AllocateLog();
<a name="l00140"></a>00140
<a name="l00142"></a>00142 <span class="keyword">static</span> <span class="keywordtype">void</span> CleanupLog();
<a name="l00143"></a>00143
<a name="l00146"></a>00146 <span class="keyword">static</span> <span class="keywordtype">double</span> GetUniversalTime();
<a name="l00147"></a>00147
<a name="l00150"></a>00150 <span class="keyword">static</span> <span class="keywordtype">double</span> GetCPUTime();
<a name="l00151"></a>00151
<a name="l00153"></a>00153 <span class="keywordtype">void</span> StartTimer();
<a name="l00154"></a>00154
<a name="l00156"></a>00156 <span class="keywordtype">void</span> StopTimer();
<a name="l00157"></a>00157
<a name="l00160"></a>00160 <span class="keywordtype">double</span> GetElapsedTime();
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="preprocessor">#ifdef VTK_WORKAROUND_WINDOWS_MANGLE</span>
<a name="l00163"></a>00163 <span class="preprocessor"></span><span class="preprocessor"># define GetTickCount GetCurrentTime</span>
<a name="l00164"></a>00164 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00165"></a>00165 <span class="preprocessor"></span>
<a name="l00168"></a>00168 VTK_LEGACY(<span class="keyword">static</span> <span class="keywordtype">double</span> GetCurrentTime());
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="preprocessor">#ifdef VTK_WORKAROUND_WINDOWS_MANGLE</span>
<a name="l00171"></a>00171 <span class="preprocessor"></span><span class="preprocessor"># undef GetTickCount</span>
<a name="l00172"></a>00172 <span class="preprocessor"></span> <span class="comment">//BTX</span>
<a name="l00173"></a>00173 VTK_LEGACY(<span class="keyword">static</span> <span class="keywordtype">double</span> GetTickCount());
<a name="l00174"></a>00174 <span class="comment">//ETX</span>
<a name="l00175"></a>00175 <span class="preprocessor">#endif</span>
<a name="l00176"></a>00176 <span class="preprocessor"></span>
<a name="l00177"></a>00177 <span class="keyword">protected</span>:
<a name="l00178"></a><a class="code" href="a01715.html#bb3dd0b99d49beefb94253e4537dd3bf">00178</a> <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>() {this->StartTime=0; this->EndTime = 0;}; <span class="comment">//insure constructor/destructor protected</span>
<a name="l00179"></a><a class="code" href="a01715.html#aaca5d7f44bc69400dc2f16fb40455f6">00179</a> <span class="keyword">virtual</span> ~<a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>() { };
<a name="l00180"></a>00180
<a name="l00181"></a>00181 <span class="keyword">static</span> <a class="code" href="a01716.html">vtkTimerLogEntry</a>* GetEvent(<span class="keywordtype">int</span> i);
<a name="l00182"></a>00182
<a name="l00183"></a><a class="code" href="a01715.html#15158c1cc7862eb6087bddfc7a663235">00183</a> <span class="keyword">static</span> <span class="keywordtype">int</span> Logging;
<a name="l00184"></a><a class="code" href="a01715.html#c22d46fdcfb40f6ac3aa45e8213344d7">00184</a> <span class="keyword">static</span> <span class="keywordtype">int</span> Indent;
<a name="l00185"></a><a class="code" href="a01715.html#84e30ec169a0446f145cd6db492e8e2b">00185</a> <span class="keyword">static</span> <span class="keywordtype">int</span> MaxEntries;
<a name="l00186"></a><a class="code" href="a01715.html#1c54f4629f05c70e50e29f18d2013e6b">00186</a> <span class="keyword">static</span> <span class="keywordtype">int</span> NextEntry;
<a name="l00187"></a><a class="code" href="a01715.html#218c94267dac28c28f2c4242b0771da0">00187</a> <span class="keyword">static</span> <span class="keywordtype">int</span> WrapFlag;
<a name="l00188"></a><a class="code" href="a01715.html#566cebd371b709c907912eee893040f5">00188</a> <span class="keyword">static</span> <span class="keywordtype">int</span> TicksPerSecond;
<a name="l00189"></a><a class="code" href="a01715.html#b6606ad27a11a342f62cb6c0394ffb9d">00189</a> <span class="keyword">static</span> <a class="code" href="a01716.html">vtkTimerLogEntry</a> *TimerLog;
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="preprocessor">#ifdef _WIN32</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span><span class="preprocessor">#ifndef _WIN32_WCE</span>
<a name="l00193"></a>00193 <span class="preprocessor"></span> <span class="keyword">static</span> timeb FirstWallTime;
<a name="l00194"></a>00194 <span class="keyword">static</span> timeb CurrentWallTime;
<a name="l00195"></a>00195 <span class="preprocessor">#else</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span> <span class="keyword">static</span> FILETIME FirstWallTime;
<a name="l00197"></a>00197 <span class="keyword">static</span> FILETIME CurrentWallTime;
<a name="l00198"></a>00198 <span class="preprocessor">#endif</span>
<a name="l00199"></a>00199 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00200"></a><a class="code" href="a01715.html#a79d81e5be34c56a3badba9d36a4fc75">00200</a> <span class="preprocessor"></span> <span class="keyword">static</span> timeval FirstWallTime;
<a name="l00201"></a><a class="code" href="a01715.html#1fe1d28da25730c0120b4cf418cf91c9">00201</a> <span class="keyword">static</span> timeval CurrentWallTime;
<a name="l00202"></a><a class="code" href="a01715.html#b0ac2b10bfe7d64a0de5afe81f093306">00202</a> <span class="keyword">static</span> tms FirstCpuTicks;
<a name="l00203"></a><a class="code" href="a01715.html#066340d0080050345a5d0711caa2adaf">00203</a> <span class="keyword">static</span> tms CurrentCpuTicks;
<a name="l00204"></a>00204 <span class="preprocessor">#endif</span>
<a name="l00205"></a>00205 <span class="preprocessor"></span>
<a name="l00206"></a>00206 <span class="comment">// instance variables to support simple timing functionality,</span>
<a name="l00207"></a>00207 <span class="comment">// separate from timer table logging.</span>
<a name="l00208"></a><a class="code" href="a01715.html#0d0e92b09e559005ae83f0157d0a96af">00208</a> <span class="keywordtype">double</span> StartTime;
<a name="l00209"></a><a class="code" href="a01715.html#f05473b8c4470276aaa3830e82a60622">00209</a> <span class="keywordtype">double</span> EndTime;
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="comment">//BTX</span>
<a name="l00212"></a>00212 <span class="keyword">static</span> <span class="keywordtype">void</span> DumpEntry(ostream& os, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e519c5019582479480124c44722a451f">index</a>, <span class="keywordtype">double</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2107b83992a2109ab18b82ba0228887498e">time</a>, <span class="keywordtype">double</span> deltatime,
<a name="l00213"></a>00213 <span class="keywordtype">int</span> tick, <span class="keywordtype">int</span> deltatick, <span class="keyword">const</span> <span class="keywordtype">char</span> *event);
<a name="l00214"></a>00214 <span class="comment">//ETX</span>
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="keyword">private</span>:
<a name="l00217"></a>00217 <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>(<span class="keyword">const</span> <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>&); <span class="comment">// Not implemented.</span>
<a name="l00218"></a>00218 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01715.html" title="Timer support and logging.">vtkTimerLog</a>&); <span class="comment">// Not implemented.</span>
<a name="l00219"></a>00219 };
<a name="l00220"></a>00220
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="comment">//</span>
<a name="l00223"></a>00223 <span class="comment">// Set built-in type. Creates member Set"name"() (e.g., SetVisibility());</span>
<a name="l00224"></a>00224 <span class="comment">//</span>
<a name="l00225"></a><a class="code" href="a02145.html#f23ad9c06e23c7c381feff65f84848d0">00225</a> <span class="preprocessor">#define vtkTimerLogMacro(string) \</span>
<a name="l00226"></a>00226 <span class="preprocessor"> { \</span>
<a name="l00227"></a>00227 <span class="preprocessor"> vtkTimerLog::FormatAndMarkEvent("Mark: In %s, line %d, class %s: %s", \</span>
<a name="l00228"></a>00228 <span class="preprocessor"> __FILE__, __LINE__, this->GetClassName(), string); \</span>
<a name="l00229"></a>00229 <span class="preprocessor"> }</span>
<a name="l00230"></a>00230 <span class="preprocessor"></span>
<a name="l00231"></a>00231 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:13 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
3943
