<!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/vtkInformationObjectBaseVectorKey.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 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><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/vtkInformationObjectBaseVectorKey.h</h1><a href="a02054.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: vtkInformationObjectBaseVectorKey.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="l00024"></a>00024 <span class="preprocessor">#ifndef __vtkInformationObjectBaseVectorKey_h</span> <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define __vtkInformationObjectBaseVectorKey_h</span> <a name="l00026"></a>00026 <span class="preprocessor"></span> <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="a02051.html">vtkInformationKey.h</a>"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="a02000.html">vtkCommonInformationKeyManager.h</a>"</span> <span class="comment">// Manage instances of this type.</span> <a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="keyword">class </span>vtkInformationObjectBaseVectorValue; <a name="l00031"></a>00031 <a name="l00032"></a><a class="code" href="a00889.html">00032</a> <span class="keyword">class </span><a class="code" href="a02170.html#873ca0b83d0838a1df577536068a1730">VTK_COMMON_EXPORT</a> <a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a> : <span class="keyword">public</span> <a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a> <a name="l00033"></a>00033 { <a name="l00034"></a>00034 <span class="keyword">public</span>: <a name="l00035"></a><a class="code" href="a00889.html#de9906d1976aeb87cdd5b4550a57d066">00035</a> vtkTypeRevisionMacro(<a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>,<a class="code" href="a00886.html" title="Superclass for vtkInformation keys.">vtkInformationKey</a>); <a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="a00886.html#65055df76afda6ed7f641cfc057ffe92">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent); <a name="l00038"></a>00038 <a name="l00044"></a>00044 <a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210c713735f1d46c2694d66e85217207be2">name</a>, <a name="l00045"></a>00045 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21013c73d49b0f10fc872e9c7895421e213">location</a>, <a name="l00046"></a>00046 <span class="keyword">const</span> <span class="keywordtype">char</span>* requiredClass=0); <a name="l00047"></a>00047 <span class="comment">//</span> <a name="l00048"></a>00048 ~<a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>(); <a name="l00050"></a>00050 <a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="keywordtype">void</span> Clear(<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="l00054"></a>00054 <span class="comment">// Description:</span> <a name="l00055"></a>00055 <span class="comment">// Resize (extend) the vector to hold n objects. Any new elements</span> <a name="l00056"></a>00056 <span class="comment">// created will be null initialized.</span> <a name="l00057"></a>00057 <span class="keywordtype">void</span> Resize(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>, <span class="keywordtype">int</span> n); <a name="l00058"></a>00058 <span class="comment">// Description:</span> <a name="l00059"></a>00059 <span class="comment">// Get the vector's length.</span> <a name="l00060"></a>00060 <span class="keywordtype">int</span> Size(<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="l00061"></a><a class="code" href="a00889.html#3507cebdb383eec2898304763d9e3967">00061</a> <span class="keywordtype">int</span> Length(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>){ <span class="keywordflow">return</span> this->Size(info); } <a name="l00062"></a>00062 <span class="comment">// Description:</span> <a name="l00063"></a>00063 <span class="comment">// Put the value on the back of the vector, with ref counting.</span> <a name="l00064"></a>00064 <span class="keywordtype">void</span> Append(<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="l00065"></a>00065 <span class="comment">// Description:</span> <a name="l00066"></a>00066 <span class="comment">// Set element i of the vector to value. Resizes the vector</span> <a name="l00067"></a>00067 <span class="comment">// if needed.</span> <a name="l00068"></a>00068 <span class="keywordtype">void</span> Set(<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>, <span class="keywordtype">int</span> i); <a name="l00069"></a>00069 <span class="comment">// Description:</span> <a name="l00070"></a>00070 <span class="comment">// Copy n values from the range in source defined by [from from+n-1]</span> <a name="l00071"></a>00071 <span class="comment">// into the range in this vector defined by [to to+n-1]. Resizes </span> <a name="l00072"></a>00072 <span class="comment">// the vector if needed.</span> <a name="l00073"></a>00073 <span class="keywordtype">void</span> SetRange(<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="l00074"></a>00074 <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a> **<a class="code" href="a02995.html#7c22aa18a4e42c330618a6410d133551">source</a>, <a name="l00075"></a>00075 <span class="keywordtype">int</span> from, <a name="l00076"></a>00076 <span class="keywordtype">int</span> to, <a name="l00077"></a>00077 <span class="keywordtype">int</span> n); <a name="l00079"></a>00079 <a name="l00081"></a>00081 <a name="l00084"></a>00084 <span class="keywordtype">void</span> GetRange(<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 class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a> **dest, <a name="l00086"></a>00086 <span class="keywordtype">int</span> from, <a name="l00087"></a>00087 <span class="keywordtype">int</span> to, <a name="l00088"></a>00088 <span class="keywordtype">int</span> n); <a name="l00090"></a>00090 <a name="l00092"></a>00092 <a class="code" href="a01085.html" title="abstract base class for most VTK objects">vtkObjectBase</a> *Get(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a>* <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21023da246d4a744e861548382bb79fad81">info</a>, <span class="keywordtype">int</span> idx); <a name="l00093"></a>00093 <a name="l00094"></a>00094 <span class="comment">// _escription:</span> <a name="l00095"></a>00095 <span class="comment">// Get a pointer to the first vtkObjectBase in the vector. We are</span> <a name="l00096"></a>00096 <span class="comment">// uysing a vector of smart pointers so this is not easy to</span> <a name="l00097"></a>00097 <span class="comment">// implement.</span> <a name="l00098"></a>00098 <span class="comment">// vtkObjectBase **Get(vtkInformation* info);</span> <a name="l00099"></a>00099 <a name="l00103"></a>00103 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00886.html#f3d7e1aa92236fdbff7dd8b606b1b971">ShallowCopy</a>(<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="l00104"></a>00104 <a name="l00106"></a>00106 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00886.html#2ddb508b5fbfbe0815db32f33e0e1575">Print</a>(ostream& 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="l00107"></a>00107 <a name="l00108"></a>00108 <span class="keyword">protected</span>: <a name="l00109"></a>00109 <span class="comment">// The type required of all objects stored with this key.</span> <a name="l00110"></a><a class="code" href="a00889.html#b1a414e01c759783f15033be8262819b">00110</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* RequiredClass; <a name="l00111"></a>00111 <a name="l00112"></a>00112 <span class="keyword">private</span>: <a name="l00114"></a>00114 <a name="l00116"></a>00116 <span class="keywordtype">void</span> CreateObjectBase(); <a name="l00117"></a>00117 <span class="comment">// Description:</span> <a name="l00118"></a>00118 <span class="comment">// Check insures that if RequiredClass is set then the</span> <a name="l00119"></a>00119 <span class="comment">// type of aValue matches. return true if the two match.</span> <a name="l00120"></a>00120 <span class="keywordtype">bool</span> ValidateDerivedType(<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>* aValue); <a name="l00121"></a>00121 <span class="comment">// Description:</span> <a name="l00122"></a>00122 <span class="comment">// Get the vector associated with this key, if there is</span> <a name="l00123"></a>00123 <span class="comment">// none then associate a new vector with this key and return</span> <a name="l00124"></a>00124 <span class="comment">// that.</span> <a name="l00125"></a>00125 vtkInformationObjectBaseVectorValue *GetObjectBaseVector(<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="l00127"></a>00127 <a name="l00128"></a>00128 <span class="comment">//</span> <a name="l00129"></a>00129 <a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>(<span class="keyword">const</span> <a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>&); <span class="comment">// Not implemented.</span> <a name="l00130"></a>00130 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a00889.html" title="Key for vtkObjectBase vector values.">vtkInformationObjectBaseVectorKey</a>&); <span class="comment">// Not implemented.</span> <a name="l00131"></a>00131 }; <a name="l00132"></a>00132 <a name="l00133"></a>00133 <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 <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>