<!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/IO/vtkXMLDataReader.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/IO/vtkXMLDataReader.h</h1><a href="a03220.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: vtkXMLDataReader.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="l00026"></a>00026 <span class="preprocessor">#ifndef __vtkXMLDataReader_h</span> <a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define __vtkXMLDataReader_h</span> <a name="l00028"></a>00028 <span class="preprocessor"></span> <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="a03256.html">vtkXMLReader.h</a>"</span> <a name="l00030"></a>00030 <a name="l00031"></a><a class="code" href="a01904.html">00031</a> <span class="keyword">class </span><a class="code" href="a02170.html#aab695c81fb47ab75c91e111e17cbe2c">VTK_IO_EXPORT</a> <a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a> : <span class="keyword">public</span> <a class="code" href="a01943.html" title="Superclass for VTK&#39;s XML format readers.">vtkXMLReader</a> <a name="l00032"></a>00032 { <a name="l00033"></a>00033 <span class="keyword">public</span>: <a name="l00034"></a><a class="code" href="a01904.html#b26ee908478dffec8b1b29aeae5a6e2d">00034</a> vtkTypeRevisionMacro(<a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>,<a class="code" href="a01943.html" title="Superclass for VTK&#39;s XML format readers.">vtkXMLReader</a>); <a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="a01943.html#7285e3c0681a04507979858351b1a0e5">PrintSelf</a>(ostream& os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent); <a name="l00036"></a>00036 <a name="l00038"></a>00038 <span class="keyword">virtual</span> <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetNumberOfPoints()=0; <a name="l00039"></a>00039 <a name="l00041"></a>00041 <span class="keyword">virtual</span> <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetNumberOfCells()=0; <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="comment">// For the specified port, copy the information this reader sets up in</span> <a name="l00044"></a>00044 <span class="comment">// SetupOutputInformation to outInfo</span> <a name="l00045"></a>00045 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#f35d09b55ab024c9c28323e06f2d7da1">CopyOutputInformation</a>(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a> *outInfo, <span class="keywordtype">int</span> <a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210710cb6d12e418b21e8fb3d79ac32f51c">port</a>); <a name="l00046"></a>00046 <a name="l00047"></a>00047 <span class="keyword">protected</span>: <a name="l00048"></a>00048 <a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>(); <a name="l00049"></a>00049 ~<a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>(); <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="keywordtype">int</span> SetUpdateExtentInfo(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> *eDSA, <a name="l00052"></a>00052 <a class="code" href="a00895.html" title="Store zero or more vtkInformation instances.">vtkInformationVector</a> *infoVector, <a name="l00053"></a>00053 <span class="keywordtype">int</span> piece, <span class="keywordtype">int</span> numPieces); <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="comment">// Add functionality to methods from superclass.</span> <a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#426613728269cc9f18d4666067214d22">CreateXMLParser</a>(); <a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#157acbc4c34f0616ef9a815bd204dc05">DestroyXMLParser</a>(); <a name="l00058"></a>00058 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#509baca377e5c9adb123c71f28f757a6">SetupOutputInformation</a>(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a> *outInfo); <a name="l00059"></a>00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#7abf82e844a0dddb55ee5a232ace10d8">SetupUpdateExtentInformation</a>(<a class="code" href="a00872.html" title="Store vtkAlgorithm input/output information.">vtkInformation</a> *outInfo); <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="keywordtype">int</span> <a class="code" href="a01943.html#a4ea6d133eb5d00786a31efc94bb9c46">ReadPrimaryElement</a>(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* ePrimary); <a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="a01943.html#2bc2be346a2d31783b022acca136f089">SetupOutputData</a>(); <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="comment">// Setup the reader for a given number of pieces.</span> <a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetupPieces(<span class="keywordtype">int</span> numPieces); <a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DestroyPieces(); <a name="l00067"></a>00067 <a name="l00068"></a>00068 <span class="comment">// Read information from the file for the given piece.</span> <a name="l00069"></a>00069 <span class="keywordtype">int</span> ReadPiece(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* ePiece, <span class="keywordtype">int</span> piece); <a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ReadPiece(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* ePiece); <a name="l00071"></a>00071 <a name="l00072"></a>00072 <span class="comment">// Read data from the file for the given piece.</span> <a name="l00073"></a>00073 <span class="keywordtype">int</span> ReadPieceData(<span class="keywordtype">int</span> piece); <a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ReadPieceData(); <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a01943.html#d52fe94d563e3b4279decbd253cc3cab">ReadXMLData</a>(); <a name="l00077"></a>00077 <a name="l00078"></a>00078 <span class="comment">// Read a data array whose tuples coorrespond to points or cells.</span> <a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ReadArrayForPoints(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* da, <a name="l00080"></a>00080 <a class="code" href="a00081.html" title="Abstract superclass for all arrays.">vtkAbstractArray</a>* outArray); <a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ReadArrayForCells(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* da, <a name="l00082"></a>00082 <a class="code" href="a00081.html" title="Abstract superclass for all arrays.">vtkAbstractArray</a>* outArray); <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="comment">// Read an Array values starting at the given index and up to numValues.</span> <a name="l00085"></a>00085 <span class="comment">// This method assumes that the array is of correct size to </span> <a name="l00086"></a>00086 <span class="comment">// accomodate all numValues values. arrayIndex is the value index at which the read</span> <a name="l00087"></a>00087 <span class="comment">// values will be put in the array.</span> <a name="l00088"></a>00088 <span class="keywordtype">int</span> ReadArrayValues(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>* da, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> arrayIndex, <a class="code" href="a00081.html" title="Abstract superclass for all arrays.">vtkAbstractArray</a>* array, <a name="l00089"></a>00089 <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> startIndex, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> numValues); <a name="l00090"></a>00090 <a name="l00091"></a>00091 <a name="l00092"></a>00092 <a name="l00093"></a>00093 <span class="comment">// Callback registered with the DataProgressObserver.</span> <a name="l00094"></a>00094 <span class="keyword">static</span> <span class="keywordtype">void</span> DataProgressCallbackFunction(<a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>*, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>, <span class="keywordtype">void</span>*, <a name="l00095"></a>00095 <span class="keywordtype">void</span>*); <a name="l00096"></a>00096 <span class="comment">// Progress callback from XMLParser.</span> <a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DataProgressCallback(); <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="comment">// The number of Pieces of data found in the file.</span> <a name="l00100"></a><a class="code" href="a01904.html#814f48d323ab59f73bc01d23d439971c">00100</a> <span class="keywordtype">int</span> NumberOfPieces; <a name="l00101"></a>00101 <a name="l00102"></a>00102 <span class="comment">// The PointData and CellData element representations for each piece.</span> <a name="l00103"></a><a class="code" href="a01904.html#64393d06be0575d28585dc5ecf6e719b">00103</a> <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>** PointDataElements; <a name="l00104"></a><a class="code" href="a01904.html#7ccec17d76f4eb224519909e558aed4c">00104</a> <a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a>** CellDataElements; <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="comment">// The piece currently being read.</span> <a name="l00107"></a><a class="code" href="a01904.html#14b9192fbd681d6b2e698ee67666dab8">00107</a> <span class="keywordtype">int</span> Piece; <a name="l00108"></a>00108 <a name="l00109"></a>00109 <span class="comment">// The number of point/cell data arrays in the output. Valid after</span> <a name="l00110"></a>00110 <span class="comment">// SetupOutputData has been called.</span> <a name="l00111"></a><a class="code" href="a01904.html#342f7be706037556fdcf2e37c6445e09">00111</a> <span class="keywordtype">int</span> NumberOfPointArrays; <a name="l00112"></a><a class="code" href="a01904.html#486675a5da3ca3b05ee6c87504f7dc33">00112</a> <span class="keywordtype">int</span> NumberOfCellArrays; <a name="l00113"></a>00113 <a name="l00114"></a>00114 <span class="comment">// Flag for whether DataProgressCallback should actually update</span> <a name="l00115"></a>00115 <span class="comment">// progress.</span> <a name="l00116"></a><a class="code" href="a01904.html#6483be84bc1304315dce60f97d0868c3">00116</a> <span class="keywordtype">int</span> InReadData; <a name="l00117"></a>00117 <a name="l00118"></a>00118 <span class="comment">// The observer to report progress from reading data from XMLParser.</span> <a name="l00119"></a><a class="code" href="a01904.html#5c2011d11c4f26501f85f67dd9f8db85">00119</a> <a class="code" href="a00226.html" title="supports function callbacks">vtkCallbackCommand</a>* DataProgressObserver; <a name="l00120"></a>00120 <a name="l00121"></a>00121 <span class="comment">// Specify the last time step read, usefull to know if we need to rearead data</span> <a name="l00122"></a>00122 <span class="comment">// //PointData</span> <a name="l00123"></a><a class="code" href="a01904.html#fa44e69a35e22ee26e6c34fa64813cd1">00123</a> <span class="keywordtype">int</span> *PointDataTimeStep; <a name="l00124"></a><a class="code" href="a01904.html#a3d48da4a8fa94b2f58e64b73164a8e3">00124</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *PointDataOffset; <a name="l00125"></a>00125 <span class="keywordtype">int</span> PointDataNeedToReadTimeStep(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> *eNested); <a name="l00126"></a>00126 <a name="l00127"></a>00127 <span class="comment">//CellData</span> <a name="l00128"></a><a class="code" href="a01904.html#153ea53d15530d95ff8b418d1bb30bb8">00128</a> <span class="keywordtype">int</span> *CellDataTimeStep; <a name="l00129"></a><a class="code" href="a01904.html#0ad737ab2e503f690cfdf2bca2ee56c8">00129</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *CellDataOffset; <a name="l00130"></a>00130 <span class="keywordtype">int</span> CellDataNeedToReadTimeStep(<a class="code" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> *eNested); <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="keyword">private</span>: <a name="l00133"></a>00133 <a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>(<span class="keyword">const</span> <a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>&); <span class="comment">// Not implemented.</span> <a name="l00134"></a>00134 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01904.html" title="Superclass for VTK XML file readers.">vtkXMLDataReader</a>&); <span class="comment">// Not implemented.</span> <a name="l00135"></a>00135 }; <a name="l00136"></a>00136 <a name="l00137"></a>00137 <span class="preprocessor">#endif</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:41 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>