<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ITK: itk::ResourceProbe< ValueType, MeanType > Class Template Reference</title>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Section customized for INSIGHT : Tue Jul 17 01:02:45 2001 -->
<center>
<a href="index.html" class="qindex">Main Page</a>
<a href="modules.html" class="qindex">Groups</a>
<a href="namespaces.html" class="qindex">Namespace List</a>
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>
<a href="classes.html" class="qindex">Alphabetical List</a>
<a href="annotated.html" class="qindex">Compound List</a>
<a href="files.html" class="qindex">File
List</a>
<a href="namespacemembers.html" class="qindex">Namespace Members</a>
<a href="functions.html" class="qindex">Compound Members</a>
<a href="globals.html" class="qindex">File Members</a>
<a href="pages.html" class="qindex">Concepts</a></center>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="namespaceitk.html">itk</a>::<a class="el" href="classitk_1_1ResourceProbe.html">ResourceProbe</a>
</div>
<div class="contents">
<h1>itk::ResourceProbe< ValueType, MeanType > Class Template Reference</h1><!-- doxytag: class="itk::ResourceProbe" -->Class for computing the change of a value between two points in the code.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkResourceProbe_8h_source.html">itkResourceProbe.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for itk::ResourceProbe< ValueType, MeanType >:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1ResourceProbe__inherit__graph.png" border="0" usemap="#itk_1_1ResourceProbe_3_01ValueType_00_01MeanType_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1ResourceProbe_3_01ValueType_00_01MeanType_01_4__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1ResourceProbe.html" title="itk::ResourceProbe\< RealTimeClock::TimeStampType, RealTimeClock::TimeStampType \>" alt="" coords="839,5,1457,35"><area shape="rect" id="node7" href="classitk_1_1ResourceProbe.html" title="itk::ResourceProbe\< long, double \>" alt="" coords="1019,59,1277,88"><area shape="rect" id="node5" href="classitk_1_1TimeProbe.html" title="Class for computing the time passed between two points in the code." alt="" coords="1521,5,1641,35"><area shape="rect" id="node9" href="classitk_1_1MemoryProbe.html" title="Class for computing the memory allocated between two points in the code." alt="" coords="1511,59,1652,88"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for itk::ResourceProbe< ValueType, MeanType >:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1ResourceProbe__coll__graph.png" border="0" usemap="#itk_1_1ResourceProbe_3_01ValueType_00_01MeanType_01_4__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classitk_1_1ResourceProbe-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ValueType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#1d01cff6abe9e5b859cf9d7c6d9cceb3">GetInstantValue</a> (void) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">MeanType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#8ae3f93a861287c5e55c86e0d8ee930c">GetMean</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#717a4cc8cccab7e5e299a8a0714fcc90">GetNumberOfStarts</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#f3c538ccd528a4994cc161a3847682af">GetNumberOfStops</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ValueType </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#68091270cbf06ac01c9a2fa9b6025672">GetTotal</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#49814dbc737a2b97c0975734f5778cb5">GetType</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#61d14837cac9b1cebde3695662c3f5c4">GetUnit</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#f280349bf6ded3fb7d60c17a975f9a93">ResourceProbe</a> (const std::string &type, const std::string &unit)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#c8d3b5d012b4a7a90dbaf0f87dc6a289">Start</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#6388c1027d69524519a0e457ed79e05e">Stop</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ResourceProbe.html#da4ed841a35757388cd19c5927e18ce1">~ResourceProbe</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class ValueType, class MeanType><br>
class itk::ResourceProbe< ValueType, MeanType ></h3>
Class for computing the change of a value between two points in the code.
<p>
This class is the base class of all the probes (time, memory, etc.) between the execution of two pieces of code. It can be started and stopped in order to evaluate the execution over multiple passes.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>TimeResourceProbe, MemoryResourceProbe </dd></dl>
<p>Definition at line <a class="el" href="itkResourceProbe_8h_source.html#l00039">39</a> of file <a class="el" href="itkResourceProbe_8h_source.html">itkResourceProbe.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="36431b60589c2a6d723a7c62b66eb2f9"></a><!-- doxytag: member="itk::ResourceProbe::CountType" ref="36431b60589c2a6d723a7c62b66eb2f9" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">typedef unsigned long <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::<a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Type for counting how many times the probe has been started and stopped.
<p>Reimplemented in <a class="el" href="classitk_1_1TimeProbe.html#3b130088cff946d4123c7298035a704c">itk::TimeProbe</a>.</p>
<p>Definition at line <a class="el" href="itkResourceProbe_8h_source.html#l00045">45</a> of file <a class="el" href="itkResourceProbe_8h_source.html">itkResourceProbe.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f280349bf6ded3fb7d60c17a975f9a93"></a><!-- doxytag: member="itk::ResourceProbe::ResourceProbe" ref="f280349bf6ded3fb7d60c17a975f9a93" args="(const std::string &type, const std::string &unit)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::<a class="el" href="classitk_1_1ResourceProbe.html">ResourceProbe</a> </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>unit</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
</div>
</div><p>
<a class="anchor" name="da4ed841a35757388cd19c5927e18ce1"></a><!-- doxytag: member="itk::ResourceProbe::~ResourceProbe" ref="da4ed841a35757388cd19c5927e18ce1" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::~<a class="el" href="classitk_1_1ResourceProbe.html">ResourceProbe</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1d01cff6abe9e5b859cf9d7c6d9cceb3"></a><!-- doxytag: member="itk::ResourceProbe::GetInstantValue" ref="1d01cff6abe9e5b859cf9d7c6d9cceb3" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">virtual ValueType <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetInstantValue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the instant value of the probed system.
<p>Implemented in <a class="el" href="classitk_1_1MemoryProbe.html#f8c72c1d92ffb7c0376ded4c791e1ce9">itk::MemoryProbe</a>, and <a class="el" href="classitk_1_1TimeProbe.html#ac4c03274c502e46c863e8388180b502">itk::TimeProbe</a>.</p>
</div>
</div><p>
<a class="anchor" name="8ae3f93a861287c5e55c86e0d8ee930c"></a><!-- doxytag: member="itk::ResourceProbe::GetMean" ref="8ae3f93a861287c5e55c86e0d8ee930c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">MeanType <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetMean </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the average value changes between the starts and stops of the probe. <a class="el" href="classitk_1_1ResourceProbe.html#6388c1027d69524519a0e457ed79e05e">Stop()</a> has to be called at least once, returns 0 otherwise.
</div>
</div><p>
<a class="anchor" name="717a4cc8cccab7e5e299a8a0714fcc90"></a><!-- doxytag: member="itk::ResourceProbe::GetNumberOfStarts" ref="717a4cc8cccab7e5e299a8a0714fcc90" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a> <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetNumberOfStarts </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of times that the probe has been started
</div>
</div><p>
<a class="anchor" name="f3c538ccd528a4994cc161a3847682af"></a><!-- doxytag: member="itk::ResourceProbe::GetNumberOfStops" ref="f3c538ccd528a4994cc161a3847682af" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1ResourceProbe.html#36431b60589c2a6d723a7c62b66eb2f9">CountType</a> <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetNumberOfStops </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of times that the probe has been stopped
</div>
</div><p>
<a class="anchor" name="68091270cbf06ac01c9a2fa9b6025672"></a><!-- doxytag: member="itk::ResourceProbe::GetTotal" ref="68091270cbf06ac01c9a2fa9b6025672" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">ValueType <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetTotal </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the accumulated value changes between the starts and stops of the probe
</div>
</div><p>
<a class="anchor" name="49814dbc737a2b97c0975734f5778cb5"></a><!-- doxytag: member="itk::ResourceProbe::GetType" ref="49814dbc737a2b97c0975734f5778cb5" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetType </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the type probed value
</div>
</div><p>
<a class="anchor" name="61d14837cac9b1cebde3695662c3f5c4"></a><!-- doxytag: member="itk::ResourceProbe::GetUnit" ref="61d14837cac9b1cebde3695662c3f5c4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::GetUnit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the unit probed value
</div>
</div><p>
<a class="anchor" name="c8d3b5d012b4a7a90dbaf0f87dc6a289"></a><!-- doxytag: member="itk::ResourceProbe::Start" ref="c8d3b5d012b4a7a90dbaf0f87dc6a289" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::Start </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start counting the change of value
<p>Referenced by <a class="el" href="itkSimpleFilterWatcher_8h_source.html#l00171">itk::SimpleFilterWatcher::StartFilter()</a>, and <a class="el" href="itkXMLFilterWatcher_8h_source.html#l00059">itk::XMLFilterWatcher::StartFilter()</a>.</p>
</div>
</div><p>
<a class="anchor" name="6388c1027d69524519a0e457ed79e05e"></a><!-- doxytag: member="itk::ResourceProbe::Stop" ref="6388c1027d69524519a0e457ed79e05e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ValueType, class MeanType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1ResourceProbe.html">itk::ResourceProbe</a>< ValueType, MeanType >::Stop </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop counting the change of value
<p>Referenced by <a class="el" href="itkXMLFilterWatcher_8h_source.html#l00085">itk::XMLFilterWatcher::EndFilter()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkResourceProbe_8h_source.html">itkResourceProbe.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 06:32:13 2009 for ITK by <a href="http://www.stack.nl/~dimitri/doxygen/index.html"> <img
src="http://www.stack.nl/~dimitri/doxygen/doxygen.png" alt="doxygen"
align="middle" border=0 width=110 height=53>
</a> 1.5.9 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2000</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d5e74628f0e673bb8680aebce32b2c04
>
files
>
7992
