Sophie

Sophie

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

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: vtkSimpleConditionVariable Class Reference</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 class="current"><a href="classes.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="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkSimpleConditionVariable Class Reference</h1><!-- doxytag: class="vtkSimpleConditionVariable" --><code>#include &lt;<a class="el" href="a03797.html">vtkConditionVariable.h</a>&gt;</code>
<p>

<p>
<a href="a14461.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="a03797.html#l00111">111</a> of file <a class="el" href="a03797.html">vtkConditionVariable.h</a>.</p>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#5b6b25cb12ff7ff81aecc74944048db9">vtkSimpleConditionVariable</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#7ac701943bdab2fed20647f745e43c41">~vtkSimpleConditionVariable</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#ef8c9704b359eab2a2bccfc5a842f67f">Delete</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#0f8f3f2e2891faba7f64cc3f944abb06">Signal</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#80ef2cf81265ed4432552962ccb5a869">Broadcast</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#83f14376fa749ae7e4b509745e559a60">Wait</a> (<a class="el" href="a01552.html">vtkSimpleMutexLock</a> &amp;mutex)</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 <a class="el" href="a01547.html">vtkSimpleConditionVariable</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#82307f0800e90e76e5646c337f8199e7">New</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01547.html#b8c65a38b97737a2b47c27ae5576744a">ConditionVariable</a></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="5b6b25cb12ff7ff81aecc74944048db9"></a><!-- doxytag: member="vtkSimpleConditionVariable::vtkSimpleConditionVariable" ref="5b6b25cb12ff7ff81aecc74944048db9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkSimpleConditionVariable::vtkSimpleConditionVariable           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="7ac701943bdab2fed20647f745e43c41"></a><!-- doxytag: member="vtkSimpleConditionVariable::~vtkSimpleConditionVariable" ref="7ac701943bdab2fed20647f745e43c41" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkSimpleConditionVariable::~vtkSimpleConditionVariable           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="82307f0800e90e76e5646c337f8199e7"></a><!-- doxytag: member="vtkSimpleConditionVariable::New" ref="82307f0800e90e76e5646c337f8199e7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01547.html">vtkSimpleConditionVariable</a>* vtkSimpleConditionVariable::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="ef8c9704b359eab2a2bccfc5a842f67f"></a><!-- doxytag: member="vtkSimpleConditionVariable::Delete" ref="ef8c9704b359eab2a2bccfc5a842f67f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkSimpleConditionVariable::Delete           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03797.html#l00119">119</a> of file <a class="el" href="a03797.html">vtkConditionVariable.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0f8f3f2e2891faba7f64cc3f944abb06"></a><!-- doxytag: member="vtkSimpleConditionVariable::Signal" ref="0f8f3f2e2891faba7f64cc3f944abb06" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkSimpleConditionVariable::Signal           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Wake one thread waiting for the condition to change. 
</div>
</div><p>
<a class="anchor" name="80ef2cf81265ed4432552962ccb5a869"></a><!-- doxytag: member="vtkSimpleConditionVariable::Broadcast" ref="80ef2cf81265ed4432552962ccb5a869" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkSimpleConditionVariable::Broadcast           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Wake all threads waiting for the condition to change. 
</div>
</div><p>
<a class="anchor" name="83f14376fa749ae7e4b509745e559a60"></a><!-- doxytag: member="vtkSimpleConditionVariable::Wait" ref="83f14376fa749ae7e4b509745e559a60" args="(vtkSimpleMutexLock &amp;mutex)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int vtkSimpleConditionVariable::Wait           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01552.html">vtkSimpleMutexLock</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>mutex</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Wait for the condition to change. Upon entry, the mutex must be locked and the lock held by the calling thread. Upon exit, the mutex will be locked and held by the calling thread. Between entry and exit, the mutex will be unlocked and may be held by other threads. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>mutex</em>&nbsp;</td><td>The mutex that should be locked on entry and will be locked on exit (but not in between) </td></tr>
  </table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>Normally,this</em>&nbsp;</td><td>function returns 0. Should a thread be interrupted by a signal, a non-zero value may be returned. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b8c65a38b97737a2b47c27ae5576744a"></a><!-- doxytag: member="vtkSimpleConditionVariable::ConditionVariable" ref="b8c65a38b97737a2b47c27ae5576744a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a02001.html#d6870128f4727ac3a91e24338a2772d1">vtkConditionType</a> <a class="el" href="a01547.html#b8c65a38b97737a2b47c27ae5576744a">vtkSimpleConditionVariable::ConditionVariable</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03797.html#l00138">138</a> of file <a class="el" href="a03797.html">vtkConditionVariable.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03797.html">vtkConditionVariable.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:34:11 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>