Sophie

Sophie

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

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: dox/Common/vtkSmartPointerBase.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<h1>dox/Common/vtkSmartPointerBase.h</h1><a href="a02128.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">  Program:   Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: vtkSmartPointerBase.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment">  All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment">  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">     This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment">     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment">     PURPOSE.  See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef __vtkSmartPointerBase_h</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define __vtkSmartPointerBase_h</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="a02080.html">vtkObjectBase.h</a>"</span>
<a name="l00029"></a>00029 
<a name="l00030"></a><a class="code" href="a01563.html">00030</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00034"></a>00034   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>();
<a name="l00035"></a>00035 
<a name="l00037"></a>00037   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>(<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* r);
<a name="l00038"></a>00038 
<a name="l00041"></a>00041   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>(<span class="keyword">const</span> <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; r);
<a name="l00042"></a>00042 
<a name="l00044"></a>00044   ~<a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>();
<a name="l00045"></a>00045 
<a name="l00047"></a>00047 
<a name="l00049"></a>00049   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; operator=(<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* r);
<a name="l00050"></a>00050   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; r);
<a name="l00052"></a>00052 
<a name="l00054"></a>00054 
<a name="l00055"></a><a class="code" href="a01563.html#f1fa3ab92c7f2473b5b74912227d5585">00055</a>   <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* GetPointer()<span class="keyword"> const</span>
<a name="l00056"></a>00056 <span class="keyword">    </span>{
<a name="l00057"></a>00057     <span class="comment">// Inline implementation so smart pointer comparisons can be fully</span>
<a name="l00058"></a>00058     <span class="comment">// inlined.</span>
<a name="l00059"></a>00059     <span class="keywordflow">return</span> this-&gt;Object;
<a name="l00060"></a>00060     }
<a name="l00062"></a>00062 
<a name="l00064"></a>00064   <span class="keywordtype">void</span> Report(<a class="code" href="a00572.html" title="Detect and break reference loops.">vtkGarbageCollector</a>* collector, <span class="keyword">const</span> <span class="keywordtype">char</span>* desc);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="keyword">protected</span>:
<a name="l00067"></a>00067 
<a name="l00068"></a>00068   <span class="comment">// Initialize smart pointer to given object, but do not increment</span>
<a name="l00069"></a>00069   <span class="comment">// reference count.  The destructor will still decrement the count.</span>
<a name="l00070"></a>00070   <span class="comment">// This effectively makes it an auto-ptr.</span>
<a name="l00071"></a><a class="code" href="a01564.html">00071</a>   <span class="keyword">class </span><a class="code" href="a01564.html">NoReference</a> {};
<a name="l00072"></a>00072   <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>(<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* r, <span class="keyword">const</span> <a class="code" href="a01564.html">NoReference</a>&amp;);
<a name="l00073"></a>00073 
<a name="l00074"></a>00074   <span class="comment">// Pointer to the actual object.</span>
<a name="l00075"></a><a class="code" href="a01563.html#c3dbd2e5f2b15677caa8a764c1fa8aa5">00075</a>   <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* Object;
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="keyword">private</span>:
<a name="l00078"></a>00078   <span class="comment">// Internal utility methods.</span>
<a name="l00079"></a>00079   <span class="keywordtype">void</span> Swap(<a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; r);
<a name="l00080"></a>00080   <span class="keywordtype">void</span> Register();
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="comment">//----------------------------------------------------------------------------</span>
<a name="l00084"></a>00084 <span class="comment">// Need to use vtkstd_bool type because std: :less requires bool return</span>
<a name="l00085"></a>00085 <span class="comment">// type from operators.  This example should not be used to justify</span>
<a name="l00086"></a>00086 <span class="comment">// using bool elsewhere in VTK.</span>
<a name="l00087"></a>00087 
<a name="l00088"></a><a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">00088</a> <span class="preprocessor">#define VTK_SMART_POINTER_BASE_DEFINE_OPERATOR(op) \</span>
<a name="l00089"></a>00089 <span class="preprocessor">  inline vtkstd_bool \</span>
<a name="l00090"></a>00090 <span class="preprocessor">  operator op (const vtkSmartPointerBase&amp; l, const vtkSmartPointerBase&amp; r) \</span>
<a name="l00091"></a>00091 <span class="preprocessor">    { \</span>
<a name="l00092"></a>00092 <span class="preprocessor">    return (static_cast&lt;void*&gt;(l.GetPointer()) op \</span>
<a name="l00093"></a>00093 <span class="preprocessor">            static_cast&lt;void*&gt;(r.GetPointer())); \</span>
<a name="l00094"></a>00094 <span class="preprocessor">    } \</span>
<a name="l00095"></a>00095 <span class="preprocessor">  inline vtkstd_bool \</span>
<a name="l00096"></a>00096 <span class="preprocessor">  operator op (vtkObjectBase* l, const vtkSmartPointerBase&amp; r) \</span>
<a name="l00097"></a>00097 <span class="preprocessor">    { \</span>
<a name="l00098"></a>00098 <span class="preprocessor">    return (static_cast&lt;void*&gt;(l) op static_cast&lt;void*&gt;(r.GetPointer())); \</span>
<a name="l00099"></a>00099 <span class="preprocessor">    } \</span>
<a name="l00100"></a>00100 <span class="preprocessor">  inline vtkstd_bool \</span>
<a name="l00101"></a>00101 <span class="preprocessor">  operator op (const vtkSmartPointerBase&amp; l, vtkObjectBase* r) \</span>
<a name="l00102"></a>00102 <span class="preprocessor">    { \</span>
<a name="l00103"></a>00103 <span class="preprocessor">    return (static_cast&lt;void*&gt;(l.GetPointer()) op static_cast&lt;void*&gt;(r)); \</span>
<a name="l00104"></a>00104 <span class="preprocessor">    }</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span>
<a name="l00106"></a>00106 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(==)
<a name="l00107"></a>00107 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(!=)
<a name="l00108"></a>00108 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(&lt;)
<a name="l00109"></a>00109 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(&lt;=)
<a name="l00110"></a>00110 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(&gt;)
<a name="l00111"></a>00111 <a class="code" href="a02128.html#4a986e595b04a7ba21bde6c65b193d8c">VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</a>(&gt;=)
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <span class="preprocessor">#undef VTK_SMART_POINTER_BASE_DEFINE_OPERATOR</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span>
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 <a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> ostream&amp; <a class="code" href="a02038.html#95573118ef33adb9530ec84d741db7db">operator &lt;&lt; </a>(ostream&amp; os,
<a name="l00118"></a>00118                                         <span class="keyword">const</span> <a class="code" href="a01563.html" title="Non-templated superclass for vtkSmartPointer.">vtkSmartPointerBase</a>&amp; p);
<a name="l00120"></a>00120 
<a name="l00121"></a>00121 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35: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>