Sophie

Sophie

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

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: vtkXMLUtilities 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>vtkXMLUtilities Class Reference</h1><!-- doxytag: class="vtkXMLUtilities" --><!-- doxytag: inherits="vtkObject" --><code>#include &lt;<a class="el" href="a05058.html">vtkXMLUtilities.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkXMLUtilities:</div>
<div class="dynsection">
<p><center><img src="a16326.png" border="0" usemap="#a16327" alt="Inheritance graph"></center>
<map name="a16327">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="22,80,102,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="7,6,116,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkXMLUtilities:</div>
<div class="dynsection">
<p><center><img src="a16328.png" border="0" usemap="#a16329" alt="Collaboration graph"></center>
<map name="a16329">
<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="a16330.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
XML utilities. 
<p>
<a class="el" href="a01956.html" title="XML utilities.">vtkXMLUtilities</a> provides XML-related convenience functions. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> </dd></dl>

<p>Definition at line <a class="el" href="a05058.html#l00030">30</a> of file <a class="el" href="a05058.html">vtkXMLUtilities.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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#c0670b9943294694a57ba2db9875e3d6">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="a01956.html#9b6271cef3e5f034f9bfef3074e0e42f">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="a01956.html#f2750fd97fe27a752e2bbd6debc64670">IsA</a> (const char *type)</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="a01956.html">vtkXMLUtilities</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#3028bbcfc1ee63e51e2052a229bb2907">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="a01956.html#4b546dbb710334d7266b74fe50412760">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01956.html">vtkXMLUtilities</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#1be51a6571d5ee25696d523f3a74e53c">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#f7796ec830ba09781aa13dfc91d000bd">EncodeString</a> (const char *input, int input_encoding, ostream &amp;output, int output_encoding, int special_entities=0)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#0f77f296ff9f55f5b36af61cff321318">CollateAttributes</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *, ostream &amp;, const char *sep=0)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#5442f1f431f1ef3cb823aaca46f0842c">FlattenElement</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *, ostream &amp;, <a class="el" href="a00869.html">vtkIndent</a> *indent=0, int indent_attributes=1)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#17226f111e3d2859cc3eed6cf63421c2">WriteElementToFile</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *, const char *filename, <a class="el" href="a00869.html">vtkIndent</a> *indent=0)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#1b06f9792a9f979ac0869d2fa137ecdb">ReadElementFromStream</a> (istream &amp;, int encoding=VTK_ENCODING_NONE)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#0d2881a74b4ce9e72c917db3eae35b9b">ReadElementFromString</a> (const char *str, int encoding=VTK_ENCODING_NONE)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#fd33d47d67f7fe1a38f276a70e89fe20">ReadElementFromFile</a> (const char *filename, int encoding=VTK_ENCODING_NONE)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#5945e420005cea4006bdf933f470aa24">ReadElementFromAttributeArray</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *element, const char **atts, int encoding)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#e07ce269a20624405dd09b8ed3c6c969">FindSimilarElements</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *elem, <a class="el" href="a01902.html">vtkXMLDataElement</a> *tree, <a class="el" href="a01902.html">vtkXMLDataElement</a> ***results)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#872a6719853c86c005b0608032338653">FactorElements</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *tree)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#f6168da3b47b7be465699ace0ff5fd73">UnFactorElements</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *tree)</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="a01956.html#de9ff5dbab21c0b70f5bcdb63b767583">vtkXMLUtilities</a> ()</td></tr>

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

<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#63192d29320280497439ac83c99ad909">FactorElementsInternal</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *tree, <a class="el" href="a01902.html">vtkXMLDataElement</a> *root, <a class="el" href="a01902.html">vtkXMLDataElement</a> *pool)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01956.html#015f15988130a512db08f10ca1f3d19f">UnFactorElementsInternal</a> (<a class="el" href="a01902.html">vtkXMLDataElement</a> *tree, <a class="el" href="a01902.html">vtkXMLDataElement</a> *pool)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="c0670b9943294694a57ba2db9875e3d6"></a><!-- doxytag: member="vtkXMLUtilities::Superclass" ref="c0670b9943294694a57ba2db9875e3d6" 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">vtkXMLUtilities::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p>

<p>Definition at line <a class="el" href="a05058.html#l00034">34</a> of file <a class="el" href="a05058.html">vtkXMLUtilities.h</a>.</p>

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

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

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3028bbcfc1ee63e51e2052a229bb2907"></a><!-- doxytag: member="vtkXMLUtilities::New" ref="3028bbcfc1ee63e51e2052a229bb2907" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01956.html">vtkXMLUtilities</a>* vtkXMLUtilities::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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>

</div>
</div><p>
<a class="anchor" name="9b6271cef3e5f034f9bfef3074e0e42f"></a><!-- doxytag: member="vtkXMLUtilities::GetClassName" ref="9b6271cef3e5f034f9bfef3074e0e42f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkXMLUtilities::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="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="4b546dbb710334d7266b74fe50412760"></a><!-- doxytag: member="vtkXMLUtilities::IsTypeOf" ref="4b546dbb710334d7266b74fe50412760" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkXMLUtilities::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="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="f2750fd97fe27a752e2bbd6debc64670"></a><!-- doxytag: member="vtkXMLUtilities::IsA" ref="f2750fd97fe27a752e2bbd6debc64670" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkXMLUtilities::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="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="1be51a6571d5ee25696d523f3a74e53c"></a><!-- doxytag: member="vtkXMLUtilities::SafeDownCast" ref="1be51a6571d5ee25696d523f3a74e53c" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01956.html">vtkXMLUtilities</a>* vtkXMLUtilities::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="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p>

</div>
</div><p>
<a class="anchor" name="f7796ec830ba09781aa13dfc91d000bd"></a><!-- doxytag: member="vtkXMLUtilities::EncodeString" ref="f7796ec830ba09781aa13dfc91d000bd" args="(const char *input, int input_encoding, ostream &amp;output, int output_encoding, int special_entities=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::EncodeString           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>input_encoding</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>output</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>output_encoding</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>special_entities</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Encode a string from one format to another (see VTK_ENCODING_... constants). If special_entites is true, convert some characters to their corresponding character entities. 
</div>
</div><p>
<a class="anchor" name="0f77f296ff9f55f5b36af61cff321318"></a><!-- doxytag: member="vtkXMLUtilities::CollateAttributes" ref="0f77f296ff9f55f5b36af61cff321318" args="(vtkXMLDataElement *, ostream &amp;, const char *sep=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::CollateAttributes           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>sep</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Collate a vtkXMLDataElement's attributes to a stream as a series of name="value" pairs (the separator between each pair can be specified, if not, it defaults to a space). Note that the resulting character-encoding will be UTF-8 (we assume that this function is used to create XML files/streams). 
</div>
</div><p>
<a class="anchor" name="5442f1f431f1ef3cb823aaca46f0842c"></a><!-- doxytag: member="vtkXMLUtilities::FlattenElement" ref="5442f1f431f1ef3cb823aaca46f0842c" args="(vtkXMLDataElement *, ostream &amp;, vtkIndent *indent=0, int indent_attributes=1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::FlattenElement           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ostream &amp;&nbsp;</td>
          <td class="paramname">, </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> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>indent_attributes</em> = <code>1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Flatten a <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> to a stream, i.e. output a textual stream corresponding to that XML element, its attributes and its nested elements. If 'indent' is not NULL, it is used to indent the whole tree. If 'indent' is not NULL and 'indent_attributes' is true, attributes will be indented as well. Note that the resulting character-encoding will be UTF-8 (we assume that this function is used to create XML files/streams). 
</div>
</div><p>
<a class="anchor" name="17226f111e3d2859cc3eed6cf63421c2"></a><!-- doxytag: member="vtkXMLUtilities::WriteElementToFile" ref="17226f111e3d2859cc3eed6cf63421c2" args="(vtkXMLDataElement *, const char *filename, vtkIndent *indent=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkXMLUtilities::WriteElementToFile           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</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> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Write a <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> to a file (in a flattened textual form) Note that the resulting character-encoding will be UTF-8. Return 1 on success, 0 otherwise. 
</div>
</div><p>
<a class="anchor" name="1b06f9792a9f979ac0869d2fa137ecdb"></a><!-- doxytag: member="vtkXMLUtilities::ReadElementFromStream" ref="1b06f9792a9f979ac0869d2fa137ecdb" args="(istream &amp;, int encoding=VTK_ENCODING_NONE)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01902.html">vtkXMLDataElement</a>* vtkXMLUtilities::ReadElementFromStream           </td>
          <td>(</td>
          <td class="paramtype">istream &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>encoding</em> = <code>VTK_ENCODING_NONE</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read a <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> from a stream, string or file. The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> encoding. Return the root element on success, NULL otherwise. Note that you have to call <a class="el" href="a01085.html#a32595c1d2734908fe30344b77b77b32">Delete()</a> on the element returned by that function to ensure it is freed properly. BTX 
</div>
</div><p>
<a class="anchor" name="0d2881a74b4ce9e72c917db3eae35b9b"></a><!-- doxytag: member="vtkXMLUtilities::ReadElementFromString" ref="0d2881a74b4ce9e72c917db3eae35b9b" args="(const char *str, int encoding=VTK_ENCODING_NONE)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01902.html">vtkXMLDataElement</a>* vtkXMLUtilities::ReadElementFromString           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>encoding</em> = <code>VTK_ENCODING_NONE</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read a <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> from a stream, string or file. The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> encoding. Return the root element on success, NULL otherwise. Note that you have to call <a class="el" href="a01085.html#a32595c1d2734908fe30344b77b77b32">Delete()</a> on the element returned by that function to ensure it is freed properly. BTX 
</div>
</div><p>
<a class="anchor" name="fd33d47d67f7fe1a38f276a70e89fe20"></a><!-- doxytag: member="vtkXMLUtilities::ReadElementFromFile" ref="fd33d47d67f7fe1a38f276a70e89fe20" args="(const char *filename, int encoding=VTK_ENCODING_NONE)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01902.html">vtkXMLDataElement</a>* vtkXMLUtilities::ReadElementFromFile           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>encoding</em> = <code>VTK_ENCODING_NONE</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read a <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> from a stream, string or file. The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> encoding. Return the root element on success, NULL otherwise. Note that you have to call <a class="el" href="a01085.html#a32595c1d2734908fe30344b77b77b32">Delete()</a> on the element returned by that function to ensure it is freed properly. BTX 
</div>
</div><p>
<a class="anchor" name="5945e420005cea4006bdf933f470aa24"></a><!-- doxytag: member="vtkXMLUtilities::ReadElementFromAttributeArray" ref="5945e420005cea4006bdf933f470aa24" args="(vtkXMLDataElement *element, const char **atts, int encoding)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::ReadElementFromAttributeArray           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>element</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char **&nbsp;</td>
          <td class="paramname"> <em>atts</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>encoding</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets attributes of an element from an array of encoded attributes. The 'encoding' parameter will be used to set the internal encoding of the attributes of the data elements created by those functions (conversion from the XML stream encoding to that new encoding will be performed automatically). If set to VTK_ENCODING_NONE, the encoding won't be changed and will default to the default <a class="el" href="a01902.html" title="Represents an XML element and those nested inside.">vtkXMLDataElement</a> encoding. 
</div>
</div><p>
<a class="anchor" name="e07ce269a20624405dd09b8ed3c6c969"></a><!-- doxytag: member="vtkXMLUtilities::FindSimilarElements" ref="e07ce269a20624405dd09b8ed3c6c969" args="(vtkXMLDataElement *elem, vtkXMLDataElement *tree, vtkXMLDataElement ***results)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkXMLUtilities::FindSimilarElements           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>elem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> ***&nbsp;</td>
          <td class="paramname"> <em>results</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find all elements in 'tree' that are similar to 'elem' (using the <a class="el" href="a01902.html#a448f208fef079e89934e1b4f6561a9f">vtkXMLDataElement::IsEqualTo()</a> predicate). Return the number of elements found and store those elements in 'results' (automatically allocated). Warning: the results do not include 'elem' if it was found in the tree ; do not forget to deallocate 'results' if something was found. BTX 
</div>
</div><p>
<a class="anchor" name="872a6719853c86c005b0608032338653"></a><!-- doxytag: member="vtkXMLUtilities::FactorElements" ref="872a6719853c86c005b0608032338653" args="(vtkXMLDataElement *tree)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::FactorElements           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Factor and unfactor a tree. This operation looks for duplicate elements in the tree, and replace them with references to a pool of elements. Unfactoring a non-factored element is harmless. 
</div>
</div><p>
<a class="anchor" name="f6168da3b47b7be465699ace0ff5fd73"></a><!-- doxytag: member="vtkXMLUtilities::UnFactorElements" ref="f6168da3b47b7be465699ace0ff5fd73" args="(vtkXMLDataElement *tree)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void vtkXMLUtilities::UnFactorElements           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Factor and unfactor a tree. This operation looks for duplicate elements in the tree, and replace them with references to a pool of elements. Unfactoring a non-factored element is harmless. 
</div>
</div><p>
<a class="anchor" name="63192d29320280497439ac83c99ad909"></a><!-- doxytag: member="vtkXMLUtilities::FactorElementsInternal" ref="63192d29320280497439ac83c99ad909" args="(vtkXMLDataElement *tree, vtkXMLDataElement *root, vtkXMLDataElement *pool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkXMLUtilities::FactorElementsInternal           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="015f15988130a512db08f10ca1f3d19f"></a><!-- doxytag: member="vtkXMLUtilities::UnFactorElementsInternal" ref="015f15988130a512db08f10ca1f3d19f" args="(vtkXMLDataElement *tree, vtkXMLDataElement *pool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkXMLUtilities::UnFactorElementsInternal           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>tree</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01902.html">vtkXMLDataElement</a> *&nbsp;</td>
          <td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/IO/<a class="el" href="a05058.html">vtkXMLUtilities.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:49:31 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>