<!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::TimeStamp Class 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_1TimeStamp.html">TimeStamp</a>
</div>
<div class="contents">
<h1>itk::TimeStamp Class Reference<br>
<small>
[<a class="el" href="group__ITKSystemObjects.html">ITK System Objects</a>]</small>
</h1><!-- doxytag: class="itk::TimeStamp" -->Generate a unique, increasing time value.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>></code>
<p>
<p>
<a href="classitk_1_1TimeStamp-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 <a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#d93008c08ac39b4f378ef03882cc7629">Self</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#614a5152705dd9142033ede067f0fab8">Delete</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#8c3a7a9a8d3fcda9230b5942446f579b">GetMTime</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#b6c6a4041a98583713f2198401e06bd2">Modified</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#51c0a0bce06f98a8071b9c60918ee097">operator unsigned long</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#bc3d09e582e1c33c60e0a08fdf7b0d3c">TimeStamp</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#a86a3c1d87707c70553b2727e8665ab6">operator<</a> (<a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> &ts)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#7bd5205944fcadba39cf48d3807901ca">operator></a> (<a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> &ts)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#97be3ce46da532c1c2f53a4cafecde39">GetNameOfClass</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classitk_1_1TimeStamp.html">Self</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1TimeStamp.html#fc4b3784cc54a51c9301d850fb2e88f8">New</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Generate a unique, increasing time value.
<p>
<a class="el" href="classitk_1_1TimeStamp.html" title="Generate a unique, increasing time value.">TimeStamp</a> records a unique time when the method <a class="el" href="classitk_1_1TimeStamp.html#b6c6a4041a98583713f2198401e06bd2">Modified()</a> is executed. This time is guaranteed to be monotonically increasing. Classes use this object to record modified and/or execution time. There is built in support for the binary < and > comparison operators between two <a class="el" href="classitk_1_1TimeStamp.html" title="Generate a unique, increasing time value.">TimeStamp</a> objects.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>On most platforms, this class uses a lock-free incremental counter. The Modified function can safely be called simultaneously by multiple threads on different instances of the class. However, calling the Modified function by different threads on the same instance of the class can lead to some unexpected behavior. The global counter will always be correct but the local m_ModifiedTime might not (see <a href="http://www.itk.org/mailman/private/insight-developers/2009-February/011732.html">http://www.itk.org/mailman/private/insight-developers/2009-February/011732.html</a> for more detail). </dd></dl>
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00049">49</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="d93008c08ac39b4f378ef03882cc7629"></a><!-- doxytag: member="itk::TimeStamp::Self" ref="d93008c08ac39b4f378ef03882cc7629" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> <a class="el" href="classitk_1_1TimeStamp.html">itk::TimeStamp::Self</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard class typedefs.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00053">53</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bc3d09e582e1c33c60e0a08fdf7b0d3c"></a><!-- doxytag: member="itk::TimeStamp::TimeStamp" ref="bc3d09e582e1c33c60e0a08fdf7b0d3c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">itk::TimeStamp::TimeStamp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor must remain public because classes instantiate TimeStamps implicitly in their construction.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00061">61</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="614a5152705dd9142033ede067f0fab8"></a><!-- doxytag: member="itk::TimeStamp::Delete" ref="614a5152705dd9142033ede067f0fab8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void itk::TimeStamp::Delete </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destoy this instance.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00065">65</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8c3a7a9a8d3fcda9230b5942446f579b"></a><!-- doxytag: member="itk::TimeStamp::GetMTime" ref="8c3a7a9a8d3fcda9230b5942446f579b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long itk::TimeStamp::GetMTime </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return this object's Modified time.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00082">82</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="97be3ce46da532c1c2f53a4cafecde39"></a><!-- doxytag: member="itk::TimeStamp::GetNameOfClass" ref="97be3ce46da532c1c2f53a4cafecde39" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* itk::TimeStamp::GetNameOfClass </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The class name as a string.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00069">69</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b6c6a4041a98583713f2198401e06bd2"></a><!-- doxytag: member="itk::TimeStamp::Modified" ref="b6c6a4041a98583713f2198401e06bd2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void itk::TimeStamp::Modified </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this objects time to the current time. The current time is just a monotonically increasing unsigned long integer. It is possible for this number to wrap around back to zero. This should only happen for processes that have been running for a very long time, while constantly changing objects within the program. When this does occur, the typical consequence should be that some filters will update themselves when really they don't need to.
<p>Referenced by <a class="el" href="itkMatrixOffsetTransformBase_8h_source.html#l00180">itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix()</a>, <a class="el" href="itkMatrixOffsetTransformBase_8h_source.html#l00390">itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetVarInverseMatrix()</a>, and <a class="el" href="itkMatrixOffsetTransformBase_8h_source.html#l00407">itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetVarMatrix()</a>.</p>
</div>
</div><p>
<a class="anchor" name="fc4b3784cc54a51c9301d850fb2e88f8"></a><!-- doxytag: member="itk::TimeStamp::New" ref="fc4b3784cc54a51c9301d850fb2e88f8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classitk_1_1TimeStamp.html">Self</a>* itk::TimeStamp::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an instance of this class. We don't want to use reference counting.
</div>
</div><p>
<a class="anchor" name="51c0a0bce06f98a8071b9c60918ee097"></a><!-- doxytag: member="itk::TimeStamp::operator unsigned long" ref="51c0a0bce06f98a8071b9c60918ee097" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">itk::TimeStamp::operator unsigned long </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow for typcasting to unsigned long.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00093">93</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a86a3c1d87707c70553b2727e8665ab6"></a><!-- doxytag: member="itk::TimeStamp::operator<" ref="a86a3c1d87707c70553b2727e8665ab6" args="(TimeStamp &ts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool itk::TimeStamp::operator< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> & </td>
<td class="paramname"> <em>ts</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Support comparisons of time stamp objects directly.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00088">88</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7bd5205944fcadba39cf48d3807901ca"></a><!-- doxytag: member="itk::TimeStamp::operator>" ref="7bd5205944fcadba39cf48d3807901ca" args="(TimeStamp &ts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool itk::TimeStamp::operator> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classitk_1_1TimeStamp.html">TimeStamp</a> & </td>
<td class="paramname"> <em>ts</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Support comparisons of time stamp objects directly.
<p>Definition at line <a class="el" href="itkTimeStamp_8h_source.html#l00086">86</a> of file <a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkTimeStamp_8h_source.html">itkTimeStamp.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 07:34:47 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
>
10104
