Sophie

Sophie

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

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: vtkGarbageCollector 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>vtkGarbageCollector Class Reference</h1><!-- doxytag: class="vtkGarbageCollector" --><!-- doxytag: inherits="vtkObject" --><code>#include &lt;<a class="el" href="a03823.html">vtkGarbageCollector.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkGarbageCollector:</div>
<div class="dynsection">
<p><center><img src="a09956.png" border="0" usemap="#a09957" alt="Inheritance graph"></center>
<map name="a09957">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="39,80,119,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="24,6,133,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkGarbageCollector:</div>
<div class="dynsection">
<p><center><img src="a09958.png" border="0" usemap="#a09959" alt="Collaboration graph"></center>
<map name="a09959">
<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,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a09960.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Detect and break reference loops. 
<p>
<a class="el" href="a00572.html" title="Detect and break reference loops.">vtkGarbageCollector</a> is used by VTK classes that may be involved in reference counting loops (such as Algorithm &lt;-&gt; Executive). It detects strongly connected components of the reference graph that have been leaked deletes them. The garbage collector uses the ReportReferences method to search the reference graph and construct a net reference count for each connected component. If the net reference count is zero the entire set of objects is deleted. Deleting each component may leak other components, which are then collected recursively.<p>
To enable garbage collection for a class, add these members:<p>
<div class="fragment"><pre class="fragment">  <span class="keyword">public</span>:
   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01085.html#830c927684d2b23593ec447f1c274f57">Register</a>(<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* o)
     {
     this-&gt;<a class="code" href="a01084.html#9ad473fb408a6689c5a21f1a3ff395d8">RegisterInternal</a>(o, 1);
     }
   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01085.html#2f77b7beccf178c43570367c50c41567">UnRegister</a>(<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* o)
     {
     this-&gt;<a class="code" href="a01084.html#988d3e166a2aa2f861e57efd123b2626">UnRegisterInternal</a>(o, 1);
     }

  <span class="keyword">protected</span>:

   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01085.html#c6aa962bedb220056f91add33044f24e">ReportReferences</a>(<a class="code" href="a00572.html" title="Detect and break reference loops.">vtkGarbageCollector</a>* collector)
     {
     <span class="comment">// Report references held by this object that may be in a loop.</span>
     this-&gt;<a class="code" href="a01085.html#c6aa962bedb220056f91add33044f24e">Superclass::ReportReferences</a>(collector);
     <a class="code" href="a02027.html#6c10a99a4cb312499644f58e3b48b7c2">vtkGarbageCollectorReport</a>(collector, this-&gt;OtherObject, <span class="stringliteral">"Other Object"</span>);
     }
</pre></div><p>
The implementations should be in the .cxx file in practice. It is important that the reference be reported using the real pointer or smart pointer instance that holds the reference. When collecting the garbage collector will actually set this pointer to NULL. The destructor of the class should be written to deal with this. It is also expected that an invariant is maintained for any reference that is reported. The variable holding the reference must always either be NULL or refer to a fully constructed valid object. Therefore code like "this-&gt;Object-&gt;UnRegister(this)" must be avoided if "this-&gt;Object" is a reported reference because it is possible that the object is deleted before UnRegister returns but then "this-&gt;Object" will be left as a dangling pointer. Instead use code like<p>
<div class="fragment"><pre class="fragment">   <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* obj = this-&gt;Object;
   this-&gt;Object = 0;
   obj-&gt;<a class="code" href="a01085.html#2f77b7beccf178c43570367c50c41567">UnRegister</a>(<span class="keyword">this</span>);
</pre></div><p>
so that the reported reference maintains the invariant.<p>
If subclassing from a class that already supports garbage collection, one need only provide the ReportReferences method.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_6.html#c2_vtk_t_vtkGarbageCollector">vtkGarbageCollector (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a03823.html#l00097">97</a> of file <a class="el" href="a03823.html">vtkGarbageCollector.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="a00572.html#dd8f1906983f78e67090dda850b9e343">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="a00572.html#f6810afe3e6890125d6019d5c0a35bf3">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="a00572.html#79e51d227f2f40eaf10fad0871001faa">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="a00572.html#8c050dfd30a1fd17d89bc903769ec1f7">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</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 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#4e0c30f1fca2b70c9e75ea939796dd68">IsTypeOf</a> (const char *type)</td></tr>

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

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00572.html">vtkGarbageCollector</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#cc52b3870ff51329e49da6c0e4714728">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#6f265318d94813cedfb96052cbdbaa28">Collect</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#5fc295c13f0704c1eb54e818db67f522">Collect</a> (<a class="el" href="a01085.html">vtkObjectBase</a> *root)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#3ad5e8f040fb24524748ff46c8293bc0">DeferredCollectionPush</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#31fe171cdfac213ddbca216c09245bf1">DeferredCollectionPop</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#bb4490b66c696d66c04d738d0fb7f028">SetGlobalDebugFlag</a> (int flag)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#628fdff8cc8da2751e83c89bc9567fa3">GetGlobalDebugFlag</a> ()</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="a00572.html#b1326a9e7175be1f95fab9f8a655b81b">vtkGarbageCollector</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#4838bc90b638b53d1e7defc93e97b799">~vtkGarbageCollector</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="a00572.html#2396e0de1799e25bfb180082bba62467">vtkGarbageCollectorManager</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#999cda672d0b1d118f9bf3705749c4d8">vtkObjectBaseToGarbageCollectorFriendship</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void VTK_COMMON_EXPORT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00572.html#fcbd542f291676a9e1bd7063f4429186">vtkGarbageCollectorReportInternal</a> (<a class="el" href="a00572.html">vtkGarbageCollector</a> *, <a class="el" href="a01085.html">vtkObjectBase</a> *, void *, const char *)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="dd8f1906983f78e67090dda850b9e343"></a><!-- doxytag: member="vtkGarbageCollector::Superclass" ref="dd8f1906983f78e67090dda850b9e343" 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">vtkGarbageCollector::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="a03823.html#l00100">100</a> of file <a class="el" href="a03823.html">vtkGarbageCollector.h</a>.</p>

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

<p>

</div>
</div><p>
<a class="anchor" name="4838bc90b638b53d1e7defc93e97b799"></a><!-- doxytag: member="vtkGarbageCollector::~vtkGarbageCollector" ref="4838bc90b638b53d1e7defc93e97b799" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkGarbageCollector::~vtkGarbageCollector           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f6810afe3e6890125d6019d5c0a35bf3"></a><!-- doxytag: member="vtkGarbageCollector::GetClassName" ref="f6810afe3e6890125d6019d5c0a35bf3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkGarbageCollector::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="4e0c30f1fca2b70c9e75ea939796dd68"></a><!-- doxytag: member="vtkGarbageCollector::IsTypeOf" ref="4e0c30f1fca2b70c9e75ea939796dd68" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkGarbageCollector::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="79e51d227f2f40eaf10fad0871001faa"></a><!-- doxytag: member="vtkGarbageCollector::IsA" ref="79e51d227f2f40eaf10fad0871001faa" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkGarbageCollector::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="1b2b4aa59c414f2b5cde8f419c507541"></a><!-- doxytag: member="vtkGarbageCollector::SafeDownCast" ref="1b2b4aa59c414f2b5cde8f419c507541" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00572.html">vtkGarbageCollector</a>* vtkGarbageCollector::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="8c050dfd30a1fd17d89bc903769ec1f7"></a><!-- doxytag: member="vtkGarbageCollector::PrintSelf" ref="8c050dfd30a1fd17d89bc903769ec1f7" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkGarbageCollector::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="cc52b3870ff51329e49da6c0e4714728"></a><!-- doxytag: member="vtkGarbageCollector::New" ref="cc52b3870ff51329e49da6c0e4714728" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00572.html">vtkGarbageCollector</a>* vtkGarbageCollector::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="6f265318d94813cedfb96052cbdbaa28"></a><!-- doxytag: member="vtkGarbageCollector::Collect" ref="6f265318d94813cedfb96052cbdbaa28" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkGarbageCollector::Collect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Collect immediately using any objects whose collection was previously deferred as a root for the reference graph walk. Strongly connected components in the reference graph are identified. Those with a net reference count of zero are deleted. When a component is deleted it may remove references to other components that are not part of the same reference loop but are held by objects in the original component. These removed references are handled as any other and their corresponding checks may be deferred. This method keeps collecting until no deferred collection checks remain. 
</div>
</div><p>
<a class="anchor" name="5fc295c13f0704c1eb54e818db67f522"></a><!-- doxytag: member="vtkGarbageCollector::Collect" ref="5fc295c13f0704c1eb54e818db67f522" args="(vtkObjectBase *root)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkGarbageCollector::Collect           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01085.html">vtkObjectBase</a> *&nbsp;</td>
          <td class="paramname"> <em>root</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Collect immediately using the given object as the root for a reference graph walk. Strongly connected components in the reference graph are identified. Those with a net reference count of zero are deleted. When a component is deleted it may remove references to other components that are not part of the same reference loop but are held by objects in the original component. These removed references are handled as any other and their corresponding checks may be deferred. This method does continue collecting in this case. 
</div>
</div><p>
<a class="anchor" name="3ad5e8f040fb24524748ff46c8293bc0"></a><!-- doxytag: member="vtkGarbageCollector::DeferredCollectionPush" ref="3ad5e8f040fb24524748ff46c8293bc0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkGarbageCollector::DeferredCollectionPush           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Push/Pop whether to do deferred collection. Whenever the total number of pushes exceeds the total number of pops collection will be deferred. Code can call the Collect method directly to force collection. 
</div>
</div><p>
<a class="anchor" name="31fe171cdfac213ddbca216c09245bf1"></a><!-- doxytag: member="vtkGarbageCollector::DeferredCollectionPop" ref="31fe171cdfac213ddbca216c09245bf1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkGarbageCollector::DeferredCollectionPop           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Push/Pop whether to do deferred collection. Whenever the total number of pushes exceeds the total number of pops collection will be deferred. Code can call the Collect method directly to force collection. 
</div>
</div><p>
<a class="anchor" name="bb4490b66c696d66c04d738d0fb7f028"></a><!-- doxytag: member="vtkGarbageCollector::SetGlobalDebugFlag" ref="bb4490b66c696d66c04d738d0fb7f028" args="(int flag)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkGarbageCollector::SetGlobalDebugFlag           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>flag</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get global garbage collection debugging flag. When set to 1, all garbage collection checks will produce debugging information. 
</div>
</div><p>
<a class="anchor" name="628fdff8cc8da2751e83c89bc9567fa3"></a><!-- doxytag: member="vtkGarbageCollector::GetGlobalDebugFlag" ref="628fdff8cc8da2751e83c89bc9567fa3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkGarbageCollector::GetGlobalDebugFlag           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get global garbage collection debugging flag. When set to 1, all garbage collection checks will produce debugging information. 
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="2396e0de1799e25bfb180082bba62467"></a><!-- doxytag: member="vtkGarbageCollector::vtkGarbageCollectorManager" ref="2396e0de1799e25bfb180082bba62467" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="a00573.html">vtkGarbageCollectorManager</a><code> [friend]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03823.html#l00168">168</a> of file <a class="el" href="a03823.html">vtkGarbageCollector.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="999cda672d0b1d118f9bf3705749c4d8"></a><!-- doxytag: member="vtkGarbageCollector::vtkObjectBaseToGarbageCollectorFriendship" ref="999cda672d0b1d118f9bf3705749c4d8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class vtkObjectBaseToGarbageCollectorFriendship<code> [friend]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03823.html#l00169">169</a> of file <a class="el" href="a03823.html">vtkGarbageCollector.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fcbd542f291676a9e1bd7063f4429186"></a><!-- doxytag: member="vtkGarbageCollector::vtkGarbageCollectorReportInternal" ref="fcbd542f291676a9e1bd7063f4429186" args="(vtkGarbageCollector *, vtkObjectBase *, void *, const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void VTK_COMMON_EXPORT vtkGarbageCollectorReportInternal           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00572.html">vtkGarbageCollector</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01085.html">vtkObjectBase</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

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