<!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: vtkOutputStream 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>vtkOutputStream Class Reference</h1><!-- doxytag: class="vtkOutputStream" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a04958.html">vtkOutputStream.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkOutputStream:</div>
<div class="dynsection">
<p><center><img src="a12651.png" border="0" usemap="#a12652" alt="Inheritance graph"></center>
<map name="a12652">
<area shape="rect" href="a00161.html" title="Writes base64-encoded output to a stream." alt="" coords="5,229,176,256"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="51,80,131,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="36,5,145,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkOutputStream:</div>
<div class="dynsection">
<p><center><img src="a12653.png" border="0" usemap="#a12654" alt="Collaboration graph"></center>
<map name="a12654">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a12655.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Wraps a binary output stream with a VTK interface.
<p>
<a class="el" href="a01143.html" title="Wraps a binary output stream with a VTK interface.">vtkOutputStream</a> provides a VTK-style interface wrapping around a standard output stream. The access methods are virtual so that subclasses can transparently provide encoding of the output. Data lengths for Write calls refer to the length of the data in memory. The actual length in the stream may differ for subclasses that implement an encoding scheme.
<p>Definition at line <a class="el" href="a04958.html#l00031">31</a> of file <a class="el" href="a04958.html">vtkOutputStream.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="a01084.html">vtkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#1fe832810c1059f43390b94c5feaae60">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="a01143.html#cd40df0b69aa9f915461ac4de3429006">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="a01143.html#7676873fa5f73c81ab138f3e1579977f">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="a01143.html#77a0381006ffeec113e1a23bded6f0ad">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#3dbd29b692e3d70db84d1732501e3f07">StartWriting</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#bf7366435ab8f87cd7c591c018a5e90b">EndWriting</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#58b267b0ff33de3c5dbe1c33d1ade688">SetStream</a> (ostream *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ostream * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#86e0bbd2d3bad4e3adcf5f0522ca82cd">GetStream</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#82dbe0ee1f33548f9f2418629cd6dd04">Write</a> (const unsigned char *data, unsigned long length)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#84eca8de770348d2c76c7d879da0560e">Write</a> (const char *data, unsigned long length)</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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#925d96854693112f5c02b3ef51481f69">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01143.html">vtkOutputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#ff11016f1756a24231f710d2077e1751">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01143.html">vtkOutputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#60e449ef424462448a3cba136bfee7fc">New</a> ()</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="a01143.html#1ea50ca71711d8ab0d8bcc2bc67e5f14">vtkOutputStream</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#21f3a05be693457af0454a7025dd4810">~vtkOutputStream</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ostream * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01143.html#ad90efc437d1f232921ef14a6c8a9ee8">Stream</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="1fe832810c1059f43390b94c5feaae60"></a><!-- doxytag: member="vtkOutputStream::Superclass" ref="1fe832810c1059f43390b94c5feaae60" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkOutputStream::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#e29bf693e5124e51d34cc6ffa26a1b4f">vtkBase64OutputStream</a>.</p>
<p>Definition at line <a class="el" href="a04958.html#l00034">34</a> of file <a class="el" href="a04958.html">vtkOutputStream.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1ea50ca71711d8ab0d8bcc2bc67e5f14"></a><!-- doxytag: member="vtkOutputStream::vtkOutputStream" ref="1ea50ca71711d8ab0d8bcc2bc67e5f14" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkOutputStream::vtkOutputStream </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="21f3a05be693457af0454a7025dd4810"></a><!-- doxytag: member="vtkOutputStream::~vtkOutputStream" ref="21f3a05be693457af0454a7025dd4810" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkOutputStream::~vtkOutputStream </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="cd40df0b69aa9f915461ac4de3429006"></a><!-- doxytag: member="vtkOutputStream::GetClassName" ref="cd40df0b69aa9f915461ac4de3429006" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkOutputStream::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="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#981b949ef39e4569841aad65d990e17b">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="925d96854693112f5c02b3ef51481f69"></a><!-- doxytag: member="vtkOutputStream::IsTypeOf" ref="925d96854693112f5c02b3ef51481f69" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkOutputStream::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="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#2d9da003853a84d4cef587b4cefb2746">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="7676873fa5f73c81ab138f3e1579977f"></a><!-- doxytag: member="vtkOutputStream::IsA" ref="7676873fa5f73c81ab138f3e1579977f" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkOutputStream::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="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#d513ea2268e112e38a9556b25ac0651e">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="ff11016f1756a24231f710d2077e1751"></a><!-- doxytag: member="vtkOutputStream::SafeDownCast" ref="ff11016f1756a24231f710d2077e1751" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01143.html">vtkOutputStream</a>* vtkOutputStream::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="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#5a51a329c1ba9aa00632a1d4cb724a9a">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="60e449ef424462448a3cba136bfee7fc"></a><!-- doxytag: member="vtkOutputStream::New" ref="60e449ef424462448a3cba136bfee7fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01143.html">vtkOutputStream</a>* vtkOutputStream::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="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#2ae875c6eddcef4366d1f2e0bf755c5a">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="77a0381006ffeec113e1a23bded6f0ad"></a><!-- doxytag: member="vtkOutputStream::PrintSelf" ref="77a0381006ffeec113e1a23bded6f0ad" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkOutputStream::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="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a00161.html#8255d333b06519847be465d80665ca1f">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="58b267b0ff33de3c5dbe1c33d1ade688"></a><!-- doxytag: member="vtkOutputStream::SetStream" ref="58b267b0ff33de3c5dbe1c33d1ade688" args="(ostream *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkOutputStream::SetStream </td>
<td>(</td>
<td class="paramtype">ostream * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get/Set the real output stream.
</div>
</div><p>
<a class="anchor" name="86e0bbd2d3bad4e3adcf5f0522ca82cd"></a><!-- doxytag: member="vtkOutputStream::GetStream" ref="86e0bbd2d3bad4e3adcf5f0522ca82cd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ostream* vtkOutputStream::GetStream </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get/Set the real output stream.
</div>
</div><p>
<a class="anchor" name="3dbd29b692e3d70db84d1732501e3f07"></a><!-- doxytag: member="vtkOutputStream::StartWriting" ref="3dbd29b692e3d70db84d1732501e3f07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkOutputStream::StartWriting </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called after the stream position has been set by the caller, but before any Write calls. The stream position should not be adjusted by the caller until after an EndWriting call.
<p>Reimplemented in <a class="el" href="a00161.html#31229c5499f57de0395709d5e29b1a24">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="82dbe0ee1f33548f9f2418629cd6dd04"></a><!-- doxytag: member="vtkOutputStream::Write" ref="82dbe0ee1f33548f9f2418629cd6dd04" args="(const unsigned char *data, unsigned long length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkOutputStream::Write </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>length</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>
Write output data of the given length.
<p>Reimplemented in <a class="el" href="a00161.html#efd735dbe5d5690b6c091e0bc8c28819">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="84eca8de770348d2c76c7d879da0560e"></a><!-- doxytag: member="vtkOutputStream::Write" ref="84eca8de770348d2c76c7d879da0560e" args="(const char *data, unsigned long length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkOutputStream::Write </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write output data of the given length.
</div>
</div><p>
<a class="anchor" name="bf7366435ab8f87cd7c591c018a5e90b"></a><!-- doxytag: member="vtkOutputStream::EndWriting" ref="bf7366435ab8f87cd7c591c018a5e90b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkOutputStream::EndWriting </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called after all desired calls to Write have been made. After this call, the caller is free to change the position of the stream. Additional writes should not be done until after another call to StartWriting.
<p>Reimplemented in <a class="el" href="a00161.html#a4be594f47a4fe65c9f189c175dfa249">vtkBase64OutputStream</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="ad90efc437d1f232921ef14a6c8a9ee8"></a><!-- doxytag: member="vtkOutputStream::Stream" ref="ad90efc437d1f232921ef14a6c8a9ee8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ostream* <a class="el" href="a01143.html#ad90efc437d1f232921ef14a6c8a9ee8">vtkOutputStream::Stream</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a04958.html#l00068">68</a> of file <a class="el" href="a04958.html">vtkOutputStream.h</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="a04958.html">vtkOutputStream.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:21:49 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1146
