<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPQC: sc::Timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1Timer.html">Timer</a>
</div>
</div>
<div class="contents">
<h1>sc::Timer Class Reference</h1><!-- doxytag: class="sc::Timer" -->The <a class="el" href="classsc_1_1Timer.html" title="The Timer class uses RegionTimer to time intervals in an exception safe manner.">Timer</a> class uses <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a> to time intervals in an exception safe manner.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="regtime_8h_source.html">regtime.h</a>></code>
<p>
<p>
<a href="classsc_1_1Timer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Timer.html#a30a2e3d0847775639225989d93ff86b">Timer</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start timing a region using the default <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a> and activate the timer. <a href="#a30a2e3d0847775639225989d93ff86b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Timer.html#e6f80d84d6a38f6f8124531de3fa2158">Timer</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1RegionTimer.html">RegionTimer</a> > &, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start timing a region using the given <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>. <a href="#e6f80d84d6a38f6f8124531de3fa2158"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Timer.html#3aae3e301472417c0e235e4dad4c72e9">~Timer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop timing a region, if active. <a href="#3aae3e301472417c0e235e4dad4c72e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1Timer.html#4cd310724169a05f099593e917212a7c">reset</a> (const char *=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop timing the current region, if active. <a href="#4cd310724169a05f099593e917212a7c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classsc_1_1Timer.html" title="The Timer class uses RegionTimer to time intervals in an exception safe manner.">Timer</a> class uses <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a> to time intervals in an exception safe manner.
<p>
It will automatically call RegionTimer::enter when its constructor is called and RegionTimer::exit when its destructor is called. The reset member can also result in RegionTimer's enter and exit routines being called. The programmer is responsible for making sure that timers are exited in the reverse of the order that they are entered. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a30a2e3d0847775639225989d93ff86b"></a><!-- doxytag: member="sc::Timer::Timer" ref="a30a2e3d0847775639225989d93ff86b" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sc::Timer::Timer </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start timing a region using the default <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a> and activate the timer.
<p>
If a null name pointer is given, then the timer will not be activated.
</div>
</div><p>
<a class="anchor" name="e6f80d84d6a38f6f8124531de3fa2158"></a><!-- doxytag: member="sc::Timer::Timer" ref="e6f80d84d6a38f6f8124531de3fa2158" args="(const Ref< RegionTimer > &, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sc::Timer::Timer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1RegionTimer.html">RegionTimer</a> > & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start timing a region using the given <a class="el" href="classsc_1_1RegionTimer.html" title="The RegionTimer class is used to record the time spent in a section of code.">RegionTimer</a>.
<p>
If a null name pointer is given, then the timer will not be activated.
</div>
</div><p>
<a class="anchor" name="3aae3e301472417c0e235e4dad4c72e9"></a><!-- doxytag: member="sc::Timer::~Timer" ref="3aae3e301472417c0e235e4dad4c72e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sc::Timer::~Timer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop timing a region, if active.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4cd310724169a05f099593e917212a7c"></a><!-- doxytag: member="sc::Timer::reset" ref="4cd310724169a05f099593e917212a7c" args="(const char *=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sc::Timer::reset </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop timing the current region, if active.
<p>
If a new region name is passed in, start timing with that name. If no region name is given, the <a class="el" href="classsc_1_1Timer.html" title="The Timer class uses RegionTimer to time intervals in an exception safe manner.">Timer</a> will be deactivated.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="regtime_8h_source.html">regtime.h</a></ul>
</div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:17 2009 for <a
href="http://www.mpqc.org">MPQC</a>
2.3.1 using the documentation package <a
href="http://www.doxygen.org">Doxygen</a>
1.5.9.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
247b28499c443e092731ffba814075f2
>
files
>
881
