Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 3799

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!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/vtkConditionVariable.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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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/vtkConditionVariable.h</h1><a href="a02001.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: vtkConditionVariable.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="l00032"></a>00032 <span class="preprocessor">#ifndef __vtkConditionVariable_h</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define __vtkConditionVariable_h</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="a02078.html">vtkMutexLock.h</a>"</span> <span class="comment">// Need for friend access to vtkSimpleMutexLock</span>
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">//BTX</span>
<a name="l00040"></a>00040 <span class="preprocessor">#if defined(VTK_USE_PTHREADS) || defined(VTK_HP_PTHREADS)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#  include &lt;pthread.h&gt;</span> <span class="comment">// Need POSIX thread implementation of mutex (even win32 provides mutexes)</span>
<a name="l00042"></a>00042 <span class="keyword">typedef</span> pthread_cond_t <a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>;
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 
<a name="l00046"></a>00046 <span class="comment">// Typically a top level windows application set _WIN32_WINNT. If it is not set we set it to</span>
<a name="l00047"></a>00047 <span class="comment">// 0x0500 (Windows 2000) because visual studio 6...</span>
<a name="l00048"></a>00048 <span class="preprocessor">#ifdef VTK_USE_WIN32_THREADS</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#  ifndef _WIN32_WINNT</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#    define _WIN32_WINNT 0x0500 // Minimum windows version supported is Windows 2000.</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#  endif</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#  include "vtkWindows.h"</span> <span class="comment">// Needed for win32 CRITICAL_SECTION, HANDLE, etc.</span>
<a name="l00053"></a>00053 <span class="preprocessor">#endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 <span class="preprocessor">#ifdef VTK_USE_WIN32_THREADS</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#if 1</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059   <span class="comment">// Number of threads waiting on condition.</span>
<a name="l00060"></a>00060   <span class="keywordtype">int</span> WaitingThreadCount;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062   <span class="comment">// Lock for WaitingThreadCount</span>
<a name="l00063"></a>00063   CRITICAL_SECTION WaitingThreadCountCritSec;
<a name="l00064"></a>00064 
<a name="l00065"></a>00065   <span class="comment">// Semaphore to block threads waiting for the condition to change.</span>
<a name="l00066"></a>00066   vtkWindowsHANDLE Semaphore;
<a name="l00067"></a>00067 
<a name="l00068"></a>00068   <span class="comment">// An event used to wake up thread(s) waiting on the semaphore</span>
<a name="l00069"></a>00069   <span class="comment">// when pthread_cond_signal or pthread_cond_broadcast is called.</span>
<a name="l00070"></a>00070   vtkWindowsHANDLE DoneWaiting;
<a name="l00071"></a>00071 
<a name="l00072"></a>00072   <span class="comment">// Was pthread_cond_broadcast called?</span>
<a name="l00073"></a>00073   <span class="keywordtype">size_t</span> WasBroadcast;
<a name="l00074"></a>00074 } pthread_cond_t;
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">typedef</span> pthread_cond_t <a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>;
<a name="l00077"></a>00077 <span class="preprocessor">#  else // 0</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080   <span class="comment">// Number of threads waiting on condition.</span>
<a name="l00081"></a>00081   <span class="keywordtype">int</span> WaitingThreadCount;
<a name="l00082"></a>00082 
<a name="l00083"></a>00083   <span class="comment">// Lock for WaitingThreadCount</span>
<a name="l00084"></a>00084   CRITICAL_SECTION WaitingThreadCountCritSec;
<a name="l00085"></a>00085 
<a name="l00086"></a>00086   <span class="comment">// Number of threads to release when pthread_cond_broadcast()</span>
<a name="l00087"></a>00087   <span class="comment">// or pthread_cond_signal() is called. </span>
<a name="l00088"></a>00088   <span class="keywordtype">int</span> ReleaseCount;
<a name="l00089"></a>00089 
<a name="l00090"></a>00090   <span class="comment">// Used to prevent one thread from decrementing ReleaseCount all</span>
<a name="l00091"></a>00091   <span class="comment">// by itself instead of letting others respond.</span>
<a name="l00092"></a>00092   <span class="keywordtype">int</span> NotifyCount;
<a name="l00093"></a>00093 
<a name="l00094"></a>00094   <span class="comment">// A manual-reset event that's used to block and release waiting threads. </span>
<a name="l00095"></a>00095   vtkWindowsHANDLE Event;
<a name="l00096"></a>00096 } pthread_cond_t;
<a name="l00097"></a>00097 
<a name="l00098"></a>00098 <span class="keyword">typedef</span> pthread_cond_t <a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>;
<a name="l00099"></a>00099 <span class="preprocessor">#  endif // 0</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#endif // VTK_USE_WIN32_THREADS</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span>
<a name="l00102"></a>00102 <span class="preprocessor">#ifndef VTK_USE_PTHREADS</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor">#ifndef VTK_HP_PTHREADS</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor">#ifndef VTK_USE_WIN32_THREADS</span>
<a name="l00105"></a><a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">00105</a> <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>;
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span>
<a name="l00110"></a>00110 <span class="comment">// Condition variable that is not a vtkObject.</span>
<a name="l00111"></a><a class="code" href="a01547.html">00111</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a01547.html">vtkSimpleConditionVariable</a>
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 <span class="keyword">public</span>:
<a name="l00114"></a>00114   <a class="code" href="a01547.html">vtkSimpleConditionVariable</a>();
<a name="l00115"></a>00115   ~<a class="code" href="a01547.html">vtkSimpleConditionVariable</a>();
<a name="l00116"></a>00116 
<a name="l00117"></a>00117   <span class="keyword">static</span> <a class="code" href="a01547.html">vtkSimpleConditionVariable</a>* New();
<a name="l00118"></a>00118 
<a name="l00119"></a><a class="code" href="a01547.html#ef8c9704b359eab2a2bccfc5a842f67f">00119</a>   <span class="keywordtype">void</span> Delete() { <span class="keyword">delete</span> <span class="keyword">this</span>; }
<a name="l00120"></a>00120   
<a name="l00122"></a>00122   <span class="keywordtype">void</span> Signal();
<a name="l00123"></a>00123 
<a name="l00125"></a>00125   <span class="keywordtype">void</span> Broadcast();
<a name="l00126"></a>00126 
<a name="l00135"></a>00135   <span class="keywordtype">int</span> Wait( <a class="code" href="a01552.html">vtkSimpleMutexLock</a>&amp; mutex );
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="keyword">protected</span>:
<a name="l00138"></a><a class="code" href="a01547.html#b8c65a38b97737a2b47c27ae5576744a">00138</a>   <a class="code" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>   ConditionVariable;
<a name="l00139"></a>00139 };
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 <span class="comment">//ETX</span>
<a name="l00142"></a>00142 
<a name="l00143"></a><a class="code" href="a00314.html">00143</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keyword">public</span>:
<a name="l00146"></a>00146   <span class="keyword">static</span> <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>* <a class="code" href="a01084.html#4d5b227267c076d6f9e38483370b6612">New</a>();
<a name="l00147"></a><a class="code" href="a00314.html#9d8352393823ae4814ea2ba1264a5ac5">00147</a>   vtkTypeRevisionMacro(<a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>,<a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>);
<a name="l00148"></a>00148   <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>( ostream&amp; os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent );
<a name="l00149"></a>00149   
<a name="l00151"></a>00151   <span class="keywordtype">void</span> Signal();
<a name="l00152"></a>00152 
<a name="l00154"></a>00154   <span class="keywordtype">void</span> Broadcast();
<a name="l00155"></a>00155 
<a name="l00164"></a>00164   <span class="keywordtype">int</span> Wait( <a class="code" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a>* mutex );
<a name="l00165"></a>00165 
<a name="l00166"></a>00166 <span class="keyword">protected</span>:
<a name="l00167"></a><a class="code" href="a00314.html#f0d424a2f8d2a96c64fc839c1672638a">00167</a>   <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>() { }
<a name="l00168"></a>00168 
<a name="l00169"></a>00169   <span class="comment">//BTX</span>
<a name="l00170"></a><a class="code" href="a00314.html#5be59ca16850460dab4c0d922c3ab16d">00170</a>   <a class="code" href="a01547.html">vtkSimpleConditionVariable</a> SimpleConditionVariable;
<a name="l00171"></a>00171   <span class="comment">//ETX</span>
<a name="l00172"></a>00172 
<a name="l00173"></a>00173 <span class="keyword">private</span>:
<a name="l00174"></a>00174   <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>( <span class="keyword">const</span> <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>&amp; ); <span class="comment">// Not implemented.</span>
<a name="l00175"></a>00175   <span class="keywordtype">void</span> operator = ( <span class="keyword">const</span> <a class="code" href="a00314.html" title="mutual exclusion locking class">vtkConditionVariable</a>&amp; ); <span class="comment">// Not implemented.</span>
<a name="l00176"></a>00176 };
<a name="l00177"></a>00177 
<a name="l00178"></a>00178 <span class="comment">//BTX</span>
<a name="l00179"></a><a class="code" href="a00314.html#673bf50304251a8c6d9dc76c06fc7ab2">00179</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="a00314.html#673bf50304251a8c6d9dc76c06fc7ab2">vtkConditionVariable::Signal</a>()
<a name="l00180"></a>00180 {
<a name="l00181"></a>00181   this-&gt;<a class="code" href="a00314.html#5be59ca16850460dab4c0d922c3ab16d">SimpleConditionVariable</a>.<a class="code" href="a01547.html#0f8f3f2e2891faba7f64cc3f944abb06">Signal</a>();
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183 
<a name="l00184"></a><a class="code" href="a00314.html#4fa29e3aa838b1b4f94eb0ccad4fd172">00184</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="a00314.html#4fa29e3aa838b1b4f94eb0ccad4fd172">vtkConditionVariable::Broadcast</a>()
<a name="l00185"></a>00185 {
<a name="l00186"></a>00186   this-&gt;<a class="code" href="a00314.html#5be59ca16850460dab4c0d922c3ab16d">SimpleConditionVariable</a>.<a class="code" href="a01547.html#80ef2cf81265ed4432552962ccb5a869">Broadcast</a>();
<a name="l00187"></a>00187 }
<a name="l00188"></a>00188 
<a name="l00189"></a><a class="code" href="a00314.html#23899d9d361ef47d5fc72cb28171ddaa">00189</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="a00314.html#23899d9d361ef47d5fc72cb28171ddaa">vtkConditionVariable::Wait</a>( <a class="code" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a>* lock )
<a name="l00190"></a>00190 {
<a name="l00191"></a>00191   <span class="keywordflow">return</span> this-&gt;<a class="code" href="a00314.html#5be59ca16850460dab4c0d922c3ab16d">SimpleConditionVariable</a>.<a class="code" href="a01547.html#83f14376fa749ae7e4b509745e559a60">Wait</a>( lock-&gt;<a class="code" href="a01074.html#811c049db417cd197ab5ae2eb63d6873">SimpleMutexLock</a> );
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193 <span class="comment">//ETX</span>
<a name="l00194"></a>00194 
<a name="l00195"></a>00195 <span class="preprocessor">#endif // __vtkConditionVariable_h</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:09 2009 for VTK by&nbsp;
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional