Sophie

Sophie

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

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/vtkInformationKey.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/vtkInformationKey.h</h1><a href="a02051.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: vtkInformationKey.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="l00028"></a>00028 <span class="preprocessor">#ifndef __vtkInformationKey_h</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define __vtkInformationKey_h</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="a02080.html">vtkObjectBase.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span> <span class="comment">// Need vtkTypeRevisionMacro</span>
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>;
<a name="l00035"></a>00035 
<a name="l00036"></a><a class="code" href="a00886.html">00036</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a> : <span class="keyword">public</span> <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a><a class="code" href="a00886.html#dbd0da103a7d660b028ecbd01ee7ae7c">00039</a>   vtkTypeRevisionMacro(<a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>,<a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>);
<a name="l00040"></a>00040   <span class="keywordtype">void</span> <a class="code" href="a01085.html#08b8a2d0047a4d9b787c4a822bcda456">PrintSelf</a>(ostream&amp; os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00041"></a>00041 
<a name="l00043"></a>00043   <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>*);
<a name="l00044"></a>00044 
<a name="l00046"></a>00046   <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>*);
<a name="l00047"></a>00047 
<a name="l00050"></a>00050   <span class="keyword">const</span> <span class="keywordtype">char</span>* GetName();
<a name="l00051"></a>00051 
<a name="l00054"></a>00054   <span class="keyword">const</span> <span class="keywordtype">char</span>* GetLocation();
<a name="l00055"></a>00055 
<a name="l00057"></a>00057 
<a name="l00062"></a>00062   <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21013c73d49b0f10fc872e9c7895421e213">location</a>);
<a name="l00063"></a>00063   ~<a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>();
<a name="l00065"></a>00065 
<a name="l00069"></a>00069   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ShallowCopy(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* from, <a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* to)=0;
<a name="l00070"></a>00070 
<a name="l00072"></a>00072 
<a name="l00076"></a><a class="code" href="a00886.html#c3cc447100b00c275bbad8602cf04604">00076</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeepCopy(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a> *from, <a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a> *to)
<a name="l00077"></a>00077     { this-&gt;ShallowCopy(from, to); }
<a name="l00079"></a>00079 
<a name="l00081"></a>00081   <span class="keyword">virtual</span> <span class="keywordtype">int</span> Has(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>);
<a name="l00082"></a>00082 
<a name="l00084"></a>00084   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Remove(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>);
<a name="l00085"></a>00085 
<a name="l00087"></a>00087   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Report(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>, <a class="code" href="a00572.html" title="Detect and break reference loops.">vtkGarbageCollector</a>* collector);
<a name="l00088"></a>00088 
<a name="l00090"></a>00090 
<a name="l00091"></a>00091   <span class="keywordtype">void</span> <a class="code" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print</a>(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>);
<a name="l00092"></a>00092   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print</a>(ostream&amp; os, <a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>);
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 <span class="keyword">protected</span>:
<a name="l00096"></a><a class="code" href="a00886.html#d8b2acf344556427d126058ef130ac67">00096</a>   <span class="keyword">const</span> <span class="keywordtype">char</span>* Name;
<a name="l00097"></a><a class="code" href="a00886.html#73e5749cd280656008c4a4d081ed00a8">00097</a>   <span class="keyword">const</span> <span class="keywordtype">char</span>* Location;
<a name="l00098"></a>00098 
<a name="l00099"></a>00099   <span class="comment">// Set/Get the value associated with this key instance in the given</span>
<a name="l00100"></a>00100   <span class="comment">// information object.</span>
<a name="l00101"></a>00101   <span class="keywordtype">void</span> SetAsObjectBase(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>, <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d2106bf5e5151797630e91167caab3f22b9a">value</a>);
<a name="l00102"></a>00102   <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a>* GetAsObjectBase(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>);
<a name="l00103"></a>00103 
<a name="l00104"></a>00104   <span class="comment">// Report the object associated with this key instance in the given</span>
<a name="l00105"></a>00105   <span class="comment">// information object to the collector.</span>
<a name="l00106"></a>00106   <span class="keywordtype">void</span> ReportAsObjectBase(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>,
<a name="l00107"></a>00107                           <a class="code" href="a00572.html" title="Detect and break reference loops.">vtkGarbageCollector</a>* collector);
<a name="l00108"></a>00108 
<a name="l00109"></a>00109   <span class="comment">// Helper for debug leaks support.</span>
<a name="l00110"></a>00110   <span class="keywordtype">void</span> ConstructClass(<span class="keyword">const</span> <span class="keywordtype">char</span>*);
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="keyword">private</span>:
<a name="l00113"></a>00113   <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>(<span class="keyword">const</span> <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>&amp;);  <span class="comment">// Not implemented.</span>
<a name="l00114"></a>00114   <span class="keywordtype">void</span> <a class="code" href="a01085.html#2726f0dad4d247e86a8fe3be3d351fca">operator=</a>(<span class="keyword">const</span> <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>&amp;);  <span class="comment">// Not implemented.</span>
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 <span class="comment">// Macros to define an information key instance in a C++ source file.</span>
<a name="l00118"></a>00118 <span class="comment">// The corresponding method declaration must appear in the class</span>
<a name="l00119"></a>00119 <span class="comment">// definition in the header file.</span>
<a name="l00120"></a><a class="code" href="a02051.html#40f7e49763ac586a92e88ff9d4af38b0">00120</a> <span class="preprocessor">#define vtkInformationKeyMacro(CLASS, NAME, type)             \</span>
<a name="l00121"></a>00121 <span class="preprocessor"> vtkInformation##type##Key* CLASS::NAME()                     \</span>
<a name="l00122"></a>00122 <span class="preprocessor">   {                                                          \</span>
<a name="l00123"></a>00123 <span class="preprocessor">   static vtkInformation##type##Key* CLASS##_##NAME =         \</span>
<a name="l00124"></a>00124 <span class="preprocessor">        new vtkInformation##type##Key(#NAME, #CLASS);         \</span>
<a name="l00125"></a>00125 <span class="preprocessor">   return CLASS##_##NAME;                                     \</span>
<a name="l00126"></a>00126 <span class="preprocessor">   }</span>
<a name="l00127"></a><a class="code" href="a02051.html#8885e12b2a01f1c0695de487ba8923de">00127</a> <span class="preprocessor"></span><span class="preprocessor">#define vtkInformationKeyRestrictedMacro(CLASS, NAME, type, required)   \</span>
<a name="l00128"></a>00128 <span class="preprocessor"> vtkInformation##type##Key* CLASS::NAME()                               \</span>
<a name="l00129"></a>00129 <span class="preprocessor">   {                                                                    \</span>
<a name="l00130"></a>00130 <span class="preprocessor">   static vtkInformation##type##Key* CLASS##_##NAME =                   \</span>
<a name="l00131"></a>00131 <span class="preprocessor">     new vtkInformation##type##Key(#NAME, #CLASS, required);            \</span>
<a name="l00132"></a>00132 <span class="preprocessor">   return CLASS##_##NAME;                                               \</span>
<a name="l00133"></a>00133 <span class="preprocessor">   }</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>
<a name="l00135"></a>00135 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:10 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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional