Sophie

Sophie

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

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: vtkStructuredGridWriter 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>vtkStructuredGridWriter Class Reference</h1><!-- doxytag: class="vtkStructuredGridWriter" --><!-- doxytag: inherits="vtkDataWriter" --><code>#include &lt;<a class="el" href="a04992.html">vtkStructuredGridWriter.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkStructuredGridWriter:</div>
<div class="dynsection">
<p><center><img src="a14853.png" border="0" usemap="#a14854" alt="Inheritance graph"></center>
<map name="a14854">
<area shape="rect" href="a00393.html" title="helper class for objects that write vtk data files" alt="" coords="35,304,141,331"><area shape="rect" href="a01891.html" title="abstract class to write data to file(s)" alt="" coords="49,230,127,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="39,155,137,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="48,80,128,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="33,6,143,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkStructuredGridWriter:</div>
<div class="dynsection">
<p><center><img src="a14855.png" border="0" usemap="#a14856" alt="Collaboration graph"></center>
<map name="a14856">
<area shape="rect" href="a00393.html" title="helper class for objects that write vtk data files" alt="" coords="679,576,785,603"><area shape="rect" href="a01891.html" title="abstract class to write data to file(s)" alt="" coords="693,499,771,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="579,381,677,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="397,173,477,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="141,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="5,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,665,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,373,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a14857.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
write vtk structured grid data file 
<p>
<a class="el" href="a01634.html" title="write vtk structured grid data file">vtkStructuredGridWriter</a> is a source object that writes ASCII or binary structured grid data files in vtk format. See text for format details.<p>
<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="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_15.html#c2_vtk_t_vtkStructuredGridWriter">vtkStructuredGridWriter (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04992.html#l00035">35</a> of file <a class="el" href="a04992.html">vtkStructuredGridWriter.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="a01634.html#9afc535586226bf9166f4b21e28ea185">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="a01634.html#8f54b5c6023c87ea204fd33a9989169d">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="a01634.html#60cb99b21ac3d7aeada9226d22e1c39f">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="a01634.html#c1e455192de9a637a8dd7fc82cf2ded2">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="a01625.html">vtkStructuredGrid</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#5c4a0d80f6364aeccf8bdb3fe3b56d64">GetInput</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01625.html">vtkStructuredGrid</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#a97d9b939c30d7f417f5aefaf8b4ad2f">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="a01634.html">vtkStructuredGridWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#daaa16ce2c7a3a0e37b31678136fc893">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="a01634.html#aaf9f8e2278a31912df2370132a795b4">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01634.html">vtkStructuredGridWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#3c49e0a05930afa0d5685d4b872fe350">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="a01634.html#ca2ef7c8fae784360b4dbe55a0d5635e">vtkStructuredGridWriter</a> ()</td></tr>

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

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

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#7675c6d5c20f073973c8e842442761a9">WriteBlanking</a> (ostream *fp, <a class="el" href="a01625.html">vtkStructuredGrid</a> *ds)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#0e6c23e6917fef8d1a455923ad7d694c">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="9afc535586226bf9166f4b21e28ea185"></a><!-- doxytag: member="vtkStructuredGridWriter::Superclass" ref="9afc535586226bf9166f4b21e28ea185" 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">vtkStructuredGridWriter::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

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

<p>Definition at line <a class="el" href="a04992.html#l00039">39</a> of file <a class="el" href="a04992.html">vtkStructuredGridWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ca2ef7c8fae784360b4dbe55a0d5635e"></a><!-- doxytag: member="vtkStructuredGridWriter::vtkStructuredGridWriter" ref="ca2ef7c8fae784360b4dbe55a0d5635e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkStructuredGridWriter::vtkStructuredGridWriter           </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="a04992.html#l00049">49</a> of file <a class="el" href="a04992.html">vtkStructuredGridWriter.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fe7181b29e04155d54e02558e0eb496b"></a><!-- doxytag: member="vtkStructuredGridWriter::~vtkStructuredGridWriter" ref="fe7181b29e04155d54e02558e0eb496b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkStructuredGridWriter::~vtkStructuredGridWriter           </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="a04992.html#l00050">50</a> of file <a class="el" href="a04992.html">vtkStructuredGridWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="daaa16ce2c7a3a0e37b31678136fc893"></a><!-- doxytag: member="vtkStructuredGridWriter::New" ref="daaa16ce2c7a3a0e37b31678136fc893" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01634.html">vtkStructuredGridWriter</a>* vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="8f54b5c6023c87ea204fd33a9989169d"></a><!-- doxytag: member="vtkStructuredGridWriter::GetClassName" ref="8f54b5c6023c87ea204fd33a9989169d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="aaf9f8e2278a31912df2370132a795b4"></a><!-- doxytag: member="vtkStructuredGridWriter::IsTypeOf" ref="aaf9f8e2278a31912df2370132a795b4" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="60cb99b21ac3d7aeada9226d22e1c39f"></a><!-- doxytag: member="vtkStructuredGridWriter::IsA" ref="60cb99b21ac3d7aeada9226d22e1c39f" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="3c49e0a05930afa0d5685d4b872fe350"></a><!-- doxytag: member="vtkStructuredGridWriter::SafeDownCast" ref="3c49e0a05930afa0d5685d4b872fe350" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01634.html">vtkStructuredGridWriter</a>* vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="c1e455192de9a637a8dd7fc82cf2ded2"></a><!-- doxytag: member="vtkStructuredGridWriter::PrintSelf" ref="c1e455192de9a637a8dd7fc82cf2ded2" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkStructuredGridWriter::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>

</div>
</div><p>
<a class="anchor" name="5c4a0d80f6364aeccf8bdb3fe3b56d64"></a><!-- doxytag: member="vtkStructuredGridWriter::GetInput" ref="5c4a0d80f6364aeccf8bdb3fe3b56d64" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01625.html">vtkStructuredGrid</a>* vtkStructuredGridWriter::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="a97d9b939c30d7f417f5aefaf8b4ad2f"></a><!-- doxytag: member="vtkStructuredGridWriter::GetInput" ref="a97d9b939c30d7f417f5aefaf8b4ad2f" args="(int port)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01625.html">vtkStructuredGrid</a>* vtkStructuredGridWriter::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="c0143e56a6d031d9cd605373a8d28606"></a><!-- doxytag: member="vtkStructuredGridWriter::WriteData" ref="c0143e56a6d031d9cd605373a8d28606" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkStructuredGridWriter::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="7675c6d5c20f073973c8e842442761a9"></a><!-- doxytag: member="vtkStructuredGridWriter::WriteBlanking" ref="7675c6d5c20f073973c8e842442761a9" args="(ostream *fp, vtkStructuredGrid *ds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int vtkStructuredGridWriter::WriteBlanking           </td>
          <td>(</td>
          <td class="paramtype">ostream *&nbsp;</td>
          <td class="paramname"> <em>fp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01625.html">vtkStructuredGrid</a> *&nbsp;</td>
          <td class="paramname"> <em>ds</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="0e6c23e6917fef8d1a455923ad7d694c"></a><!-- doxytag: member="vtkStructuredGridWriter::FillInputPortInformation" ref="0e6c23e6917fef8d1a455923ad7d694c" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkStructuredGridWriter::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="a04992.html">vtkStructuredGridWriter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:37:13 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>