<!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: vtkCriticalSection 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkCriticalSection Class Reference</h1><!-- doxytag: class="vtkCriticalSection" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a03799.html">vtkCriticalSection.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkCriticalSection:</div>
<div class="dynsection">
<p><center><img src="a08895.png" border="0" usemap="#a08896" alt="Inheritance graph"></center>
<map name="a08896">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="30,80,110,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="15,6,124,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkCriticalSection:</div>
<div class="dynsection">
<p><center><img src="a08897.png" border="0" usemap="#a08898" alt="Collaboration graph"></center>
<map name="a08898">
<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="a01548.html" title="vtkSimpleCriticalSection" alt="" coords="191,96,359,123"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a08899.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Critical section locking class.
<p>
<a class="el" href="a00341.html" title="Critical section locking class.">vtkCriticalSection</a> allows the locking of variables which are accessed through different threads. This header file also defines <a class="el" href="a01548.html">vtkSimpleCriticalSection</a> which is not a subclass of <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>. The API is identical to that of <a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a>, and the behavior is identical as well, except on Windows 9x/NT platforms. The only difference on these platforms is that <a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a> is more flexible, in that it works across processes as well as across threads, but also costs more, in that it evokes a 600-cycle x86 ring transition. The <a class="el" href="a00341.html" title="Critical section locking class.">vtkCriticalSection</a> provides a higher-performance equivalent (on Windows) but won't work across processes. Since it is unclear how, in vtk, an object at the vtk level can be shared across processes in the first place, one should use <a class="el" href="a00341.html" title="Critical section locking class.">vtkCriticalSection</a> unless one has a very good reason to use <a class="el" href="a01074.html" title="mutual exclusion locking class">vtkMutexLock</a>. If higher-performance equivalents for non-Windows platforms (Irix, SunOS, etc) are discovered, they should replace the implementations in this class
<p>Definition at line <a class="el" href="a03799.html#l00107">107</a> of file <a class="el" href="a03799.html">vtkCriticalSection.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> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#bf21a139e3c9982724990b4b062ace73">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 * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#acde060ec2bbce02ca88514ce9ea63f4">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#5d316124b29e8653c65f3d510efa0b03">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#a9b7bc055a2f43358501809eaa3302e7">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#c6884d76d759b05eeab059a684ed464f">Lock</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#18d12456522dd9bebf4181b74690be6e">Unlock</a> ()</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="a00341.html">vtkCriticalSection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#a9a97d0c22417cf6e55f16623c690bf0">New</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#c27efa71c2c399de7dff1360ad0f461a">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00341.html">vtkCriticalSection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#f0d259774625bf7558442160b337093e">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#b372b48ef29041c5799437d2894ac067">vtkCriticalSection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#342cedd4dc6af7c528cefb016919a0a4">~vtkCriticalSection</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="a01548.html">vtkSimpleCriticalSection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00341.html#cbc77eaed5ff6c1fc3f1de2e73a94f2c">SimpleCriticalSection</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="bf21a139e3c9982724990b4b062ace73"></a><!-- doxytag: member="vtkCriticalSection::Superclass" ref="bf21a139e3c9982724990b4b062ace73" 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">vtkCriticalSection::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="a03799.html#l00112">112</a> of file <a class="el" href="a03799.html">vtkCriticalSection.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b372b48ef29041c5799437d2894ac067"></a><!-- doxytag: member="vtkCriticalSection::vtkCriticalSection" ref="b372b48ef29041c5799437d2894ac067" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCriticalSection::vtkCriticalSection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03799.html#l00123">123</a> of file <a class="el" href="a03799.html">vtkCriticalSection.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="342cedd4dc6af7c528cefb016919a0a4"></a><!-- doxytag: member="vtkCriticalSection::~vtkCriticalSection" ref="342cedd4dc6af7c528cefb016919a0a4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkCriticalSection::~vtkCriticalSection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03799.html#l00124">124</a> of file <a class="el" href="a03799.html">vtkCriticalSection.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a9a97d0c22417cf6e55f16623c690bf0"></a><!-- doxytag: member="vtkCriticalSection::New" ref="a9a97d0c22417cf6e55f16623c690bf0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00341.html">vtkCriticalSection</a>* vtkCriticalSection::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="acde060ec2bbce02ca88514ce9ea63f4"></a><!-- doxytag: member="vtkCriticalSection::GetClassName" ref="acde060ec2bbce02ca88514ce9ea63f4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkCriticalSection::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="c27efa71c2c399de7dff1360ad0f461a"></a><!-- doxytag: member="vtkCriticalSection::IsTypeOf" ref="c27efa71c2c399de7dff1360ad0f461a" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkCriticalSection::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </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="5d316124b29e8653c65f3d510efa0b03"></a><!-- doxytag: member="vtkCriticalSection::IsA" ref="5d316124b29e8653c65f3d510efa0b03" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkCriticalSection::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </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="f0d259774625bf7558442160b337093e"></a><!-- doxytag: member="vtkCriticalSection::SafeDownCast" ref="f0d259774625bf7558442160b337093e" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00341.html">vtkCriticalSection</a>* vtkCriticalSection::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </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="a9b7bc055a2f43358501809eaa3302e7"></a><!-- doxytag: member="vtkCriticalSection::PrintSelf" ref="a9b7bc055a2f43358501809eaa3302e7" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCriticalSection::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </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> </td>
<td class="paramname"> <em>indent</em></td><td> </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="c6884d76d759b05eeab059a684ed464f"></a><!-- doxytag: member="vtkCriticalSection::Lock" ref="c6884d76d759b05eeab059a684ed464f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCriticalSection::Lock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Lock the <a class="el" href="a00341.html" title="Critical section locking class.">vtkCriticalSection</a>
<p>Definition at line <a class="el" href="a03799.html#l00132">132</a> of file <a class="el" href="a03799.html">vtkCriticalSection.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="18d12456522dd9bebf4181b74690be6e"></a><!-- doxytag: member="vtkCriticalSection::Unlock" ref="18d12456522dd9bebf4181b74690be6e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkCriticalSection::Unlock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unlock the <a class="el" href="a00341.html" title="Critical section locking class.">vtkCriticalSection</a>
<p>Definition at line <a class="el" href="a03799.html#l00137">137</a> of file <a class="el" href="a03799.html">vtkCriticalSection.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="cbc77eaed5ff6c1fc3f1de2e73a94f2c"></a><!-- doxytag: member="vtkCriticalSection::SimpleCriticalSection" ref="cbc77eaed5ff6c1fc3f1de2e73a94f2c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01548.html">vtkSimpleCriticalSection</a> <a class="el" href="a00341.html#cbc77eaed5ff6c1fc3f1de2e73a94f2c">vtkCriticalSection::SimpleCriticalSection</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03799.html#l00122">122</a> of file <a class="el" href="a03799.html">vtkCriticalSection.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="a03799.html">vtkCriticalSection.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:58:36 2009 for VTK by
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
344
