Sophie

Sophie

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

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: vtkMutexLock 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>vtkMutexLock Class Reference</h1><!-- doxytag: class="vtkMutexLock" --><!-- doxytag: inherits="vtkObject" --><code>#include &lt;<a class="el" href="a03874.html">vtkMutexLock.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkMutexLock:</div>
<div class="dynsection">
<p><center><img src="a12336.png" border="0" usemap="#a12337" alt="Inheritance graph"></center>
<map name="a12337">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="20,80,100,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,6,115,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkMutexLock:</div>
<div class="dynsection">
<p><center><img src="a12338.png" border="0" usemap="#a12339" alt="Collaboration graph"></center>
<map name="a12339">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,6,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,6,248,32"><area shape="rect" href="a01552.html" title="vtkSimpleMutexLock" alt="" coords="191,96,337,123"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a12340.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
mutual exclusion locking class 
<p>
<a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a> allows the locking of variables which are accessed through different threads. This header file also defines <a class="el" href="a01552.html">vtkSimpleMutexLock</a> which is not a subclass of <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_10.html#c2_vtk_t_vtkMutexLock">vtkMutexLock (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a03874.html#l00081">81</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>
<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="a01084.html">vtkObject</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#f5f6572eb8fdbdbdbb221e995890e8a2">Superclass</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 const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#bc8d89d34843dfc882c358f466707979">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#de4f37a705fdc6d377c3de68d2431d7b">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#3b3bfe635b4c85e989d83323a5d47be2">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

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

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#a537b50004767e328943167187963ce0">Unlock</a> (void)</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="a01074.html">vtkMutexLock</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#fbac66089f6fab6cd37563a74aa3b50d">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#f9fabd5cd4b55800a0b89cf5d2065302">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01074.html">vtkMutexLock</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#5a4069a69d88b747a6e0172dc51e3bc0">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><br><h2>Protected 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="a01074.html#51cb89ceaee0c7d2f76c84c92a14920e">vtkMutexLock</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="a01552.html">vtkSimpleMutexLock</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#811c049db417cd197ab5ae2eb63d6873">SimpleMutexLock</a></td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01074.html#186a549e15aee721a2ed7fbf25c3b88e">vtkConditionVariable</a></td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="f5f6572eb8fdbdbdbb221e995890e8a2"></a><!-- doxytag: member="vtkMutexLock::Superclass" ref="f5f6572eb8fdbdbdbb221e995890e8a2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkMutexLock::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p>

<p>Definition at line <a class="el" href="a03874.html#l00086">86</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="51cb89ceaee0c7d2f76c84c92a14920e"></a><!-- doxytag: member="vtkMutexLock::vtkMutexLock" ref="51cb89ceaee0c7d2f76c84c92a14920e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkMutexLock::vtkMutexLock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03874.html#l00101">101</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>

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

<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 
<p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="bc8d89d34843dfc882c358f466707979"></a><!-- doxytag: member="vtkMutexLock::GetClassName" ref="bc8d89d34843dfc882c358f466707979" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkMutexLock::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="f9fabd5cd4b55800a0b89cf5d2065302"></a><!-- doxytag: member="vtkMutexLock::IsTypeOf" ref="f9fabd5cd4b55800a0b89cf5d2065302" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkMutexLock::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="de4f37a705fdc6d377c3de68d2431d7b"></a><!-- doxytag: member="vtkMutexLock::IsA" ref="de4f37a705fdc6d377c3de68d2431d7b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkMutexLock::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="5a4069a69d88b747a6e0172dc51e3bc0"></a><!-- doxytag: member="vtkMutexLock::SafeDownCast" ref="5a4069a69d88b747a6e0172dc51e3bc0" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01074.html">vtkMutexLock</a>* vtkMutexLock::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="3b3bfe635b4c85e989d83323a5d47be2"></a><!-- doxytag: member="vtkMutexLock::PrintSelf" ref="3b3bfe635b4c85e989d83323a5d47be2" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkMutexLock::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. 
<p>Reimplemented from <a class="el" href="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p>

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

<p>
Lock the <a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a> 
<p>Definition at line <a class="el" href="a03874.html#l00108">108</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>

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

<p>
Unlock the <a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a> 
<p>Definition at line <a class="el" href="a03874.html#l00113">113</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="186a549e15aee721a2ed7fbf25c3b88e"></a><!-- doxytag: member="vtkMutexLock::vtkConditionVariable" ref="186a549e15aee721a2ed7fbf25c3b88e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="a00314.html">vtkConditionVariable</a><code> [friend]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03874.html#l00097">97</a> of file <a class="el" href="a03874.html">vtkMutexLock.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="811c049db417cd197ab5ae2eb63d6873"></a><!-- doxytag: member="vtkMutexLock::SimpleMutexLock" ref="811c049db417cd197ab5ae2eb63d6873" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01552.html">vtkSimpleMutexLock</a> <a class="el" href="a01074.html#811c049db417cd197ab5ae2eb63d6873">vtkMutexLock::SimpleMutexLock</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03874.html#l00100">100</a> of file <a class="el" href="a03874.html">vtkMutexLock.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="a03874.html">vtkMutexLock.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:19:12 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>