1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkXMLReader</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkio_vtkxmlreader.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkXMLReader </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkXMLReader uses vtkXMLDataParser to parse a VTK XML input file. Concrete subclasses then traverse the parsed file structure and extract data.</p>
<p>To create an instance of class vtkXMLReader, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkXMLReader
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkXMLReader has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkXMLReader class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkXMLReader = obj.NewInstance ()</code> </li>
<li>
<code>vtkXMLReader = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>obj.SetFileName (string )</code> - Get/Set the name of the input file. </li>
<li>
<code>string = obj.GetFileName ()</code> - Get/Set the name of the input file. </li>
<li>
<code>int = obj.CanReadFile (string name)</code> - Test whether the file with the given name can be read by this reader. </li>
<li>
<code>vtkDataSet = obj.GetOutputAsDataSet ()</code> - Get the output as a vtkDataSet pointer. </li>
<li>
<code>vtkDataSet = obj.GetOutputAsDataSet (int index)</code> - Get the output as a vtkDataSet pointer. </li>
<li>
<code>vtkDataArraySelection = obj.GetPointDataArraySelection ()</code> - Get the data array selection tables used to configure which data arrays are loaded by the reader. </li>
<li>
<code>vtkDataArraySelection = obj.GetCellDataArraySelection ()</code> - Get the data array selection tables used to configure which data arrays are loaded by the reader. </li>
<li>
<code>int = obj.GetNumberOfPointArrays ()</code> - Get the number of point or cell arrays available in the input. </li>
<li>
<code>int = obj.GetNumberOfCellArrays ()</code> - Get the number of point or cell arrays available in the input. </li>
<li>
<code>string = obj.GetPointArrayName (int index)</code> - Get the name of the point or cell array with the given index in the input. </li>
<li>
<code>string = obj.GetCellArrayName (int index)</code> - Get the name of the point or cell array with the given index in the input. </li>
<li>
<code>int = obj.GetPointArrayStatus (string name)</code> - Get/Set whether the point or cell array with the given name is to be read. </li>
<li>
<code>int = obj.GetCellArrayStatus (string name)</code> - Get/Set whether the point or cell array with the given name is to be read. </li>
<li>
<code>obj.SetPointArrayStatus (string name, int status)</code> - Get/Set whether the point or cell array with the given name is to be read. </li>
<li>
<code>obj.SetCellArrayStatus (string name, int status)</code> - Get/Set whether the point or cell array with the given name is to be read. </li>
<li>
<code>obj.CopyOutputInformation (vtkInformation , int )</code> - Which TimeStep to read. </li>
<li>
<code>obj.SetTimeStep (int )</code> - Which TimeStep to read. </li>
<li>
<code>int = obj.GetTimeStep ()</code> - Which TimeStep to read. </li>
<li>
<code>int = obj.GetNumberOfTimeSteps ()</code> </li>
<li>
<code>int = obj. GetTimeStepRange ()</code> - Which TimeStepRange to read </li>
<li>
<code>obj.SetTimeStepRange (int , int )</code> - Which TimeStepRange to read </li>
<li>
<code>obj.SetTimeStepRange (int a[2])</code> - Which TimeStepRange to read </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkio.html">Visualization Toolkit IO Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:34 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|