Sophie

Sophie

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

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: vtkDataSetWriter 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&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 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&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkDataSetWriter Class Reference</h1><!-- doxytag: class="vtkDataSetWriter" --><!-- doxytag: inherits="vtkDataWriter" --><code>#include &lt;<a class="el" href="a04902.html">vtkDataSetWriter.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkDataSetWriter:</div>
<div class="dynsection">
<p><center><img src="a09148.png" border="0" usemap="#a09149" alt="Inheritance graph"></center>
<map name="a09149">
<area shape="rect" href="a01202.html" title="Manages writing pieces of a data set." alt="" coords="6,453,142,480"><area shape="rect" href="a00393.html" title="helper class for objects that write vtk data files" alt="" coords="20,304,127,331"><area shape="rect" href="a01891.html" title="abstract class to write data to file(s)" alt="" coords="35,229,112,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="24,155,123,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="34,80,114,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="19,5,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkDataSetWriter:</div>
<div class="dynsection">
<p><center><img src="a09150.png" border="0" usemap="#a09151" alt="Collaboration graph"></center>
<map name="a09151">
<area shape="rect" href="a00393.html" title="helper class for objects that write vtk data files" alt="" coords="679,576,786,603"><area shape="rect" href="a01891.html" title="abstract class to write data to file(s)" alt="" coords="694,499,771,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="579,381,678,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="372,499,471,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="398,173,478,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="363,264,512,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="142,264,251,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="203,5,312,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="6,173,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="192,83,323,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="556,83,666,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,374,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a09152.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
write any type of vtk dataset to file 
<p>
<a class="el" href="a00392.html" title="write any type of vtk dataset to file">vtkDataSetWriter</a> is an abstract class for mapper objects that write their data to disk (or into a communications port). The input to this object is a dataset of any type.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_4.html#c2_vtk_t_vtkDataSetWriter">vtkDataSetWriter (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04902.html#l00031">31</a> of file <a class="el" href="a04902.html">vtkDataSetWriter.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="a00393.html">vtkDataWriter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#303c5baf49bb5892bff1fcda2678cd84">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 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#25d9993fb1a53e7d4ea05ddaf956ddd0">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#0d0ce7f4518bbdaafbbd255a9daa5837">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#f1d8db3d5cdfe111b52da8aa3e48f327">PrintSelf</a> (ostream &amp;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="a00374.html">vtkDataSet</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#2cf96430dafcd7e8a6c30c1b59a7104e">GetInput</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00374.html">vtkDataSet</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#09a79280f57bc83823dde13e27f299e3">GetInput</a> (int port)</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="a00392.html">vtkDataSetWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#846e4496aabf91047ecab6e1d45e1a94">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#002a0235be5ad04357a655a0e3b457b8">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00392.html">vtkDataSetWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#26453152021a21acd94fb5bc99720024">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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#918a5c7fd82cded433fac7cd42d7cc3b">vtkDataSetWriter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#9693d3b011a815e6aec94236640d63ec">~vtkDataSetWriter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#415ca90863524e7e2d3602e18d66fc94">WriteData</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00392.html#a7d624e356b10d10393494399e7c314d">FillInputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="303c5baf49bb5892bff1fcda2678cd84"></a><!-- doxytag: member="vtkDataSetWriter::Superclass" ref="303c5baf49bb5892bff1fcda2678cd84" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00393.html">vtkDataWriter</a> <a class="el" href="a00393.html">vtkDataSetWriter::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00393.html#fe9b465bc434e6cb4688211b259ef9d9">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#e0b80a715d2cc567465633669b953955">vtkPDataSetWriter</a>.</p>

<p>Definition at line <a class="el" href="a04902.html#l00035">35</a> of file <a class="el" href="a04902.html">vtkDataSetWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="918a5c7fd82cded433fac7cd42d7cc3b"></a><!-- doxytag: member="vtkDataSetWriter::vtkDataSetWriter" ref="918a5c7fd82cded433fac7cd42d7cc3b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkDataSetWriter::vtkDataSetWriter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04902.html#l00045">45</a> of file <a class="el" href="a04902.html">vtkDataSetWriter.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9693d3b011a815e6aec94236640d63ec"></a><!-- doxytag: member="vtkDataSetWriter::~vtkDataSetWriter" ref="9693d3b011a815e6aec94236640d63ec" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkDataSetWriter::~vtkDataSetWriter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04902.html#l00046">46</a> of file <a class="el" href="a04902.html">vtkDataSetWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="846e4496aabf91047ecab6e1d45e1a94"></a><!-- doxytag: member="vtkDataSetWriter::New" ref="846e4496aabf91047ecab6e1d45e1a94" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00392.html">vtkDataSetWriter</a>* vtkDataSetWriter::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Created object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates. 
<p>Reimplemented from <a class="el" href="a00393.html#90261b328a74f3f5a1daf515fb6f9cd1">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#05d60d1e6b8622e900f6b9bb6992fdc1">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="25d9993fb1a53e7d4ea05ddaf956ddd0"></a><!-- doxytag: member="vtkDataSetWriter::GetClassName" ref="25d9993fb1a53e7d4ea05ddaf956ddd0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkDataSetWriter::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00393.html#bef1afe605d22327dbcbf2eb61a975a7">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#3fcbd10598524dac16e73a6dba021593">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="002a0235be5ad04357a655a0e3b457b8"></a><!-- doxytag: member="vtkDataSetWriter::IsTypeOf" ref="002a0235be5ad04357a655a0e3b457b8" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkDataSetWriter::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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="a00393.html#afc9241a2bb6a13dd2928688036a2b37">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#3dddb5dfbe0731a0a423736323372875">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="0d0ce7f4518bbdaafbbd255a9daa5837"></a><!-- doxytag: member="vtkDataSetWriter::IsA" ref="0d0ce7f4518bbdaafbbd255a9daa5837" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkDataSetWriter::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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="a00393.html#30d179cfddbdbdbeafec73eed2a78d9a">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#898acab5a31d4dacc532d26145e14d35">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="26453152021a21acd94fb5bc99720024"></a><!-- doxytag: member="vtkDataSetWriter::SafeDownCast" ref="26453152021a21acd94fb5bc99720024" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00392.html">vtkDataSetWriter</a>* vtkDataSetWriter::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00393.html#33818d3abd31dade0bbb70ab747e3793">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#fba39aa300abff9f10bc596ecac3e61b">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="f1d8db3d5cdfe111b52da8aa3e48f327"></a><!-- doxytag: member="vtkDataSetWriter::PrintSelf" ref="f1d8db3d5cdfe111b52da8aa3e48f327" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkDataSetWriter::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</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="a00393.html#05e8aedddc9b7ee4900b3f0d8f0c99ac">vtkDataWriter</a>.</p>

<p>Reimplemented in <a class="el" href="a01202.html#77157fd6bf770dc1691f562c6689a6e3">vtkPDataSetWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="2cf96430dafcd7e8a6c30c1b59a7104e"></a><!-- doxytag: member="vtkDataSetWriter::GetInput" ref="2cf96430dafcd7e8a6c30c1b59a7104e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00374.html">vtkDataSet</a>* vtkDataSetWriter::GetInput           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the input to this writer. 
<p>Reimplemented from <a class="el" href="a01891.html#6b5a81ff411ac4cbd30a705ba9dc38e1">vtkWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="09a79280f57bc83823dde13e27f299e3"></a><!-- doxytag: member="vtkDataSetWriter::GetInput" ref="09a79280f57bc83823dde13e27f299e3" args="(int port)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00374.html">vtkDataSet</a>* vtkDataSetWriter::GetInput           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>port</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the input to this writer. 
<p>Reimplemented from <a class="el" href="a01891.html#beb0d8a002f4e1212210191572a614bd">vtkWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="415ca90863524e7e2d3602e18d66fc94"></a><!-- doxytag: member="vtkDataSetWriter::WriteData" ref="415ca90863524e7e2d3602e18d66fc94" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkDataSetWriter::WriteData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00393.html#2941c9ece55e4435a7db7b495f842109">vtkDataWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="a7d624e356b10d10393494399e7c314d"></a><!-- doxytag: member="vtkDataSetWriter::FillInputPortInformation" ref="a7d624e356b10d10393494399e7c314d" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkDataSetWriter::FillInputPortInformation           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</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> *&nbsp;</td>
          <td class="paramname"> <em>info</em></td><td>&nbsp;</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 input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle. 
<p>Reimplemented from <a class="el" href="a00101.html#aad069877868b9c2e8035a946a5d0538">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="a04902.html">vtkDataSetWriter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:59:38 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>