Sophie

Sophie

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

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: vtkWeakPointer&lt; T &gt; Class Template 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>vtkWeakPointer&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="vtkWeakPointer" --><!-- doxytag: inherits="vtkWeakPointerBase" --><code>#include &lt;<a class="el" href="a03964.html">vtkWeakPointer.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkWeakPointer&lt; T &gt;:</div>
<div class="dynsection">
<p><center><img src="a15909.png" border="0" usemap="#a15910" alt="Inheritance graph"></center>
<map name="a15910">
<area shape="rect" href="a01869.html" title="vtkWeakPointer\&lt; vtkWindow \&gt;" alt="" coords="5,173,213,200"><area shape="rect" href="a01869.html" title="vtkWeakPointer\&lt; vtkRenderWindow \&gt;" alt="" coords="237,173,491,200"><area shape="rect" href="a01870.html" title="Non&#45;templated superclass for vtkWeakPointer." alt="" coords="161,5,311,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkWeakPointer&lt; T &gt;:</div>
<div class="dynsection">
<p><center><img src="a15911.png" border="0" usemap="#a15912" alt="Collaboration graph"></center>
<map name="a15912">
<area shape="rect" href="a01870.html" title="Non&#45;templated superclass for vtkWeakPointer." alt="" coords="52,187,201,213"><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="a15913.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br>
 class vtkWeakPointer&lt; T &gt;</h3>

a weak reference to a <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>. 
<p>
<a class="el" href="a01869.html" title="a weak reference to a vtkObject.">vtkWeakPointer</a> is a weak reference to a <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> which means that assigning a <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> to the <a class="el" href="a01869.html" title="a weak reference to a vtkObject.">vtkWeakPointer</a> does not affect the reference cound of the <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>. However, when the <a class="el" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a> is destroyed, the <a class="el" href="a01869.html" title="a weak reference to a vtkObject.">vtkWeakPointer</a> gets initialized to NULL, thus avoid any dangling references. 
<p>Definition at line <a class="el" href="a03964.html#l00030">30</a> of file <a class="el" href="a03964.html">vtkWeakPointer.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="a01869.html#cc59fdeb63d85a20bdf9ee16a6ed39c3">vtkWeakPointer</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#f1b3f6c9ba9fbb4d37b8ed350094e333">vtkWeakPointer</a> (T *r)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#4728a749aae9058f02c8233177a8f3d6">vtkWeakPointer</a> (const <a class="el" href="a01870.html">vtkWeakPointerBase</a> &amp;r)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01869.html">vtkWeakPointer</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#7ed2217bbfa2b7d94e826c819828693f">operator=</a> (T *r)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01869.html">vtkWeakPointer</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#fc0c1f1f34f5eb68a2e1f81385324b52">operator=</a> (const <a class="el" href="a01870.html">vtkWeakPointerBase</a> &amp;r)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#120c06fe3bc24100982f85bb76f0048e">GetPointer</a> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#ef7802536807bf812c160bce7c2444a7">operator T *</a> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#24786c8cc63ff67a9563d9d1a5aa9282">operator*</a> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01869.html#d6570bfb9a359b23a9f50742c3a82d5e">operator-&gt;</a> () const </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="a01869.html#d17cd51b9eacc4e076ce9217ed0f880e">vtkWeakPointer</a> (T *r, const <a class="el" href="a01871.html">NoReference</a> &amp;n)</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="cc59fdeb63d85a20bdf9ee16a6ed39c3"></a><!-- doxytag: member="vtkWeakPointer::vtkWeakPointer" ref="cc59fdeb63d85a20bdf9ee16a6ed39c3" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::<a class="el" href="a01869.html">vtkWeakPointer</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize smart pointer to NULL. 
<p>Definition at line <a class="el" href="a03964.html#l00034">34</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="f1b3f6c9ba9fbb4d37b8ed350094e333"></a><!-- doxytag: member="vtkWeakPointer::vtkWeakPointer" ref="f1b3f6c9ba9fbb4d37b8ed350094e333" args="(T *r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::<a class="el" href="a01869.html">vtkWeakPointer</a>           </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize smart pointer to given object. 
<p>Definition at line <a class="el" href="a03964.html#l00037">37</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="4728a749aae9058f02c8233177a8f3d6"></a><!-- doxytag: member="vtkWeakPointer::vtkWeakPointer" ref="4728a749aae9058f02c8233177a8f3d6" args="(const vtkWeakPointerBase &amp;r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::<a class="el" href="a01869.html">vtkWeakPointer</a>           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a01870.html">vtkWeakPointerBase</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize smart pointer with the given smart pointer. 
<p>Definition at line <a class="el" href="a03964.html#l00040">40</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d17cd51b9eacc4e076ce9217ed0f880e"></a><!-- doxytag: member="vtkWeakPointer::vtkWeakPointer" ref="d17cd51b9eacc4e076ce9217ed0f880e" args="(T *r, const NoReference &amp;n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::<a class="el" href="a01869.html">vtkWeakPointer</a>           </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a01871.html">NoReference</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>n</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03964.html#l00116">116</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7ed2217bbfa2b7d94e826c819828693f"></a><!-- doxytag: member="vtkWeakPointer::operator=" ref="7ed2217bbfa2b7d94e826c819828693f" args="(T *r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&amp; <a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::operator=           </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assign object to reference. 
<p>Definition at line <a class="el" href="a03964.html#l00044">44</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fc0c1f1f34f5eb68a2e1f81385324b52"></a><!-- doxytag: member="vtkWeakPointer::operator=" ref="fc0c1f1f34f5eb68a2e1f81385324b52" args="(const vtkWeakPointerBase &amp;r)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&amp; <a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a01870.html">vtkWeakPointerBase</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>r</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assign object to reference. 
<p>Reimplemented from <a class="el" href="a01870.html#9d1bb1b3216e9e771826c098f68f314a">vtkWeakPointerBase</a>.</p>

<p>Definition at line <a class="el" href="a03964.html#l00053">53</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="120c06fe3bc24100982f85bb76f0048e"></a><!-- doxytag: member="vtkWeakPointer::GetPointer" ref="120c06fe3bc24100982f85bb76f0048e" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::GetPointer           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the contained pointer. 
<p>Reimplemented from <a class="el" href="a01870.html#4866dc3c524021d05b1a95f14d5113aa">vtkWeakPointerBase</a>.</p>

<p>Definition at line <a class="el" href="a03964.html#l00062">62</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ef7802536807bf812c160bce7c2444a7"></a><!-- doxytag: member="vtkWeakPointer::operator T *" ref="ef7802536807bf812c160bce7c2444a7" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::operator T *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the contained pointer. 
<p>Definition at line <a class="el" href="a03964.html#l00070">70</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="24786c8cc63ff67a9563d9d1a5aa9282"></a><!-- doxytag: member="vtkWeakPointer::operator*" ref="24786c8cc63ff67a9563d9d1a5aa9282" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::operator*           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Dereference the pointer and return a reference to the contained object. 
<p>Definition at line <a class="el" href="a03964.html#l00079">79</a> of file <a class="el" href="a03964.html">vtkWeakPointer.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d6570bfb9a359b23a9f50742c3a82d5e"></a><!-- doxytag: member="vtkWeakPointer::operator-&gt;" ref="d6570bfb9a359b23a9f50742c3a82d5e" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a01869.html">vtkWeakPointer</a>&lt; T &gt;::operator-&gt;           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Provides normal pointer target member access using operator -&gt;. 
<p>Definition at line <a class="el" href="a03964.html#l00087">87</a> of file <a class="el" href="a03964.html">vtkWeakPointer.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="a03964.html">vtkWeakPointer.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:45:52 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>