<!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: vtkTreeReader Class Reference</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 class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div class="contents"> <h1>vtkTreeReader Class Reference</h1><!-- doxytag: class="vtkTreeReader" --><!-- doxytag: inherits="vtkDataReader" --><code>#include <<a class="el" href="a04999.html">vtkTreeReader.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for vtkTreeReader:</div> <div class="dynsection"> <p><center><img src="a15416.png" border="0" usemap="#a15417" alt="Inheritance graph"></center> <map name="a15417"> <area shape="rect" href="a00372.html" title="helper superclass for objects that read vtk data files" alt="" coords="5,229,120,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="13,155,112,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="23,80,103,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="8,5,117,32"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <div class="dynheader"> Collaboration diagram for vtkTreeReader:</div> <div class="dynsection"> <p><center><img src="a15418.png" border="0" usemap="#a15419" alt="Collaboration graph"></center> <map name="a15419"> <area shape="rect" href="a00372.html" title="helper superclass for objects that read vtk data files" alt="" coords="1813,156,1928,183"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="1044,259,1143,286"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="1384,352,1483,379"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="444,355,524,382"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="675,304,824,331"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="695,156,804,183"><area shape="rect" href="a00081.html" title="Abstract superclass for all arrays." alt="" coords="1032,196,1155,223"><area shape="rect" href="a01513.html" title="map scalar values into colors" alt="" coords="849,456,991,483"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="7,79,116,106"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="403,28,565,55"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="169,79,300,106"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="180,355,289,382"><area shape="rect" href="a00980.html" title="map scalar values into colors via a lookup table" alt="" coords="1812,398,1929,424"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="393,79,575,106"><area shape="rect" href="a00263.html" title="dynamic, self-adjusting array of char" alt="" coords="1565,156,1669,183"><area shape="rect" href="a00356.html" title="abstract superclass for arrays of numeric data" alt="" coords="1383,200,1484,227"><area shape="rect" href="a01784.html" title="dynamic, self-adjusting array of unsigned char" alt="" coords="1537,271,1697,298"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="a15420.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> read <a class="el" href="a01741.html" title="A rooted tree data structure.">vtkTree</a> data file <p> <a class="el" href="a01756.html" title="read vtkTree data file">vtkTreeReader</a> is a source object that reads ASCII or binary <a class="el" href="a01741.html" title="A rooted tree data structure.">vtkTree</a> data files in vtk format. (see text for format details). The output of this reader is a single <a class="el" href="a01741.html" title="A rooted tree data structure.">vtkTree</a> data object. The superclass of this class, <a class="el" href="a00372.html" title="helper superclass for objects that read vtk data files">vtkDataReader</a>, provides many methods for controlling the reading of the data file, see <a class="el" href="a00372.html" title="helper superclass for objects that read vtk data files">vtkDataReader</a> for more information. <dl class="warning" compact><dt><b>Warning:</b></dt><dd>Binary files written on one system may not be readable on other systems. </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01741.html" title="A rooted tree data structure.">vtkTree</a> <a class="el" href="a00372.html" title="helper superclass for objects that read vtk data files">vtkDataReader</a> <a class="el" href="a01759.html" title="write vtkTree data to a file">vtkTreeWriter</a> </dd></dl> <p>Definition at line <a class="el" href="a04999.html#l00037">37</a> of file <a class="el" href="a04999.html">vtkTreeReader.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00372.html">vtkDataReader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#5bef6ec55dfdbb3a5fb6e6f022f78389">Superclass</a></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#2dd94c06e278201361024fa63d4b0050">GetClassName</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#eb112b51746a3f6fccce34bee5267651">IsA</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#7ceb6e7c92d1babb4bab8675087d114c">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01741.html">vtkTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#4b411cb6ecbe38ce18f58d008abbdfab">GetOutput</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01741.html">vtkTree</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#dec0f70af568a9fff9b70d851511ecc0">GetOutput</a> (int idx)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#6d01b8d51ca3b064848ae8222a49e244">SetOutput</a> (<a class="el" href="a01741.html">vtkTree</a> *output)</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01756.html">vtkTreeReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#e8a0c4a973ace2d358ca8380f3c186dd">New</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#1c913e0ed9b164c4f3b913da67e74d5e">IsTypeOf</a> (const char *type)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01756.html">vtkTreeReader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#77fc5491dca55ec560d5bd43429c2bf1">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#4a779e206e18158d65f1441bbbd6fb28">vtkTreeReader</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#a5747794df73a9efc912b5cc76256313">~vtkTreeReader</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#1181e9320b8fdae66087b636ac595a86">RequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#06c8e6fe83879e31bfeb7930d4878348">RequestUpdateExtent</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01756.html#f75c2f3d3af55785980688de9d707c1f">FillOutputPortInformation</a> (int, <a class="el" href="a00872.html">vtkInformation</a> *)</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="5bef6ec55dfdbb3a5fb6e6f022f78389"></a><!-- doxytag: member="vtkTreeReader::Superclass" ref="5bef6ec55dfdbb3a5fb6e6f022f78389" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a00372.html">vtkDataReader</a> <a class="el" href="a00372.html">vtkTreeReader::Superclass</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00372.html#98c8617daeed70f07c401a3d98c9df98">vtkDataReader</a>.</p> <p>Definition at line <a class="el" href="a04999.html#l00041">41</a> of file <a class="el" href="a04999.html">vtkTreeReader.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="4a779e206e18158d65f1441bbbd6fb28"></a><!-- doxytag: member="vtkTreeReader::vtkTreeReader" ref="4a779e206e18158d65f1441bbbd6fb28" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkTreeReader::vtkTreeReader </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="a5747794df73a9efc912b5cc76256313"></a><!-- doxytag: member="vtkTreeReader::~vtkTreeReader" ref="a5747794df73a9efc912b5cc76256313" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">vtkTreeReader::~vtkTreeReader </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e8a0c4a973ace2d358ca8380f3c186dd"></a><!-- doxytag: member="vtkTreeReader::New" ref="e8a0c4a973ace2d358ca8380f3c186dd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01756.html">vtkTreeReader</a>* vtkTreeReader::New </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an object with Debug turned off, modified time initialized to zero, and reference counting on. <p>Reimplemented from <a class="el" href="a00372.html#cf96c448e8cb1914c4456e3e83456a98">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="2dd94c06e278201361024fa63d4b0050"></a><!-- doxytag: member="vtkTreeReader::GetClassName" ref="2dd94c06e278201361024fa63d4b0050" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* vtkTreeReader::GetClassName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00372.html#9a009949d09a43cd64f6ba82629a2171">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="1c913e0ed9b164c4f3b913da67e74d5e"></a><!-- doxytag: member="vtkTreeReader::IsTypeOf" ref="1c913e0ed9b164c4f3b913da67e74d5e" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int vtkTreeReader::IsTypeOf </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. <p>Reimplemented from <a class="el" href="a00372.html#fb2b4008118e8b05c6c74c8574baf4cd">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="eb112b51746a3f6fccce34bee5267651"></a><!-- doxytag: member="vtkTreeReader::IsA" ref="eb112b51746a3f6fccce34bee5267651" args="(const char *type)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkTreeReader::IsA </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. <p>Reimplemented from <a class="el" href="a00372.html#afe872277663ac42ae126796c6ea6c8d">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="77fc5491dca55ec560d5bd43429c2bf1"></a><!-- doxytag: member="vtkTreeReader::SafeDownCast" ref="77fc5491dca55ec560d5bd43429c2bf1" args="(vtkObject *o)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="a01756.html">vtkTreeReader</a>* vtkTreeReader::SafeDownCast </td> <td>(</td> <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td> <td class="paramname"> <em>o</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Reimplemented from <a class="el" href="a00372.html#a04c5d15b1c4c1aab6c4e274efdd1e08">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="7ceb6e7c92d1babb4bab8675087d114c"></a><!-- doxytag: member="vtkTreeReader::PrintSelf" ref="7ceb6e7c92d1babb4bab8675087d114c" args="(ostream &os, vtkIndent indent)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkTreeReader::PrintSelf </td> <td>(</td> <td class="paramtype">ostream & </td> <td class="paramname"> <em>os</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td> <td class="paramname"> <em>indent</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. <p>Reimplemented from <a class="el" href="a00372.html#26e5b32cb707cb1c88a57338b1edee97">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="4b411cb6ecbe38ce18f58d008abbdfab"></a><!-- doxytag: member="vtkTreeReader::GetOutput" ref="4b411cb6ecbe38ce18f58d008abbdfab" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01741.html">vtkTree</a>* vtkTreeReader::GetOutput </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get the output of this reader. </div> </div><p> <a class="anchor" name="dec0f70af568a9fff9b70d851511ecc0"></a><!-- doxytag: member="vtkTreeReader::GetOutput" ref="dec0f70af568a9fff9b70d851511ecc0" args="(int idx)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a01741.html">vtkTree</a>* vtkTreeReader::GetOutput </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>idx</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get the output of this reader. </div> </div><p> <a class="anchor" name="6d01b8d51ca3b064848ae8222a49e244"></a><!-- doxytag: member="vtkTreeReader::SetOutput" ref="6d01b8d51ca3b064848ae8222a49e244" args="(vtkTree *output)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vtkTreeReader::SetOutput </td> <td>(</td> <td class="paramtype"><a class="el" href="a01741.html">vtkTree</a> * </td> <td class="paramname"> <em>output</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Get the output of this reader. </div> </div><p> <a class="anchor" name="1181e9320b8fdae66087b636ac595a86"></a><!-- doxytag: member="vtkTreeReader::RequestData" ref="1181e9320b8fdae66087b636ac595a86" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkTreeReader::RequestData </td> <td>(</td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> ** </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Internal function to read in a value. Returns zero if there was an error. <p>Reimplemented from <a class="el" href="a00372.html#db27db1fb754e144318ab7023019e110">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="06c8e6fe83879e31bfeb7930d4878348"></a><!-- doxytag: member="vtkTreeReader::RequestUpdateExtent" ref="06c8e6fe83879e31bfeb7930d4878348" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkTreeReader::RequestUpdateExtent </td> <td>(</td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> ** </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> * </td> <td class="paramname"></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Internal function to read in a value. Returns zero if there was an error. <p>Reimplemented from <a class="el" href="a00372.html#d5d1c0bd92cb58fbc883e199b3acd39b">vtkDataReader</a>.</p> </div> </div><p> <a class="anchor" name="f75c2f3d3af55785980688de9d707c1f"></a><!-- doxytag: member="vtkTreeReader::FillOutputPortInformation" ref="f75c2f3d3af55785980688de9d707c1f" args="(int, vtkInformation *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int vtkTreeReader::FillOutputPortInformation </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>port</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </td> <td class="paramname"> <em>info</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle. <p>Reimplemented from <a class="el" href="a00101.html#278ce83f371e6a398cf46f4600108d3e">vtkAlgorithm</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>dox/IO/<a class="el" href="a04999.html">vtkTreeReader.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:41:40 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>