Willkommen bei WordPress. Dies ist dein erster Beitrag. Bearbeite oder lösche ihn und beginne mit dem Schreiben!
Hallo Welt!
von raredesign | Dez 3, 2019 | Allgemein | 0 Kommentare
Cokiee Shell
| Current Path : /proc/self/root/usr/share/doc/libclam-doc/html/ |
| Current File : //proc/self/root/usr/share/doc/libclam-doc/html/classCLAM_1_1XmlStorage.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CLAM-Development: CLAM::XmlStorage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CLAM-Development
 <span id="projectnumber">1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCLAM.html">CLAM</a></li><li class="navelem"><a class="el" href="classCLAM_1_1XmlStorage.html">XmlStorage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CLAM::XmlStorage Class Reference<div class="ingroups"><a class="el" href="group__Xml.html">XML</a> | <a class="el" href="group__XmlDump.html">Dumping and Restoring objects on XML</a> | <a class="el" href="group__XmlCustomize.html">Customizing the XML format for your object</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Provides XML format storage for <a class="el" href="namespaceCLAM.html">CLAM</a> <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a>'s.
<a href="classCLAM_1_1XmlStorage.html#details">More...</a></p>
<p><code>#include <<a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a>></code></p>
<p><a href="classCLAM_1_1XmlStorage-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Atomic primitives to Dump and Restore</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>To be used only when you need to twickle the default behavior for summary operations (Dump, Restore...). </p>
</div></td></tr>
<tr class="memitem:abcb6623c19b0ad0191235a4fce7b5bcf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#abcb6623c19b0ad0191235a4fce7b5bcf">XmlStorage</a> ()</td></tr>
<tr class="memitem:a9a57a1831af9371ce0144a3e19e2f89f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a9a57a1831af9371ce0144a3e19e2f89f">~XmlStorage</a> ()</td></tr>
<tr class="memitem:ac17ba04364d737ddd0d2220b977b5082"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#ac17ba04364d737ddd0d2220b977b5082">Read</a> (std::istream &is)</td></tr>
<tr class="memdesc:ac17ba04364d737ddd0d2220b977b5082"><td class="mdescLeft"> </td><td class="mdescRight">Loads the DOM from the stream and selects the root node. <a href="#ac17ba04364d737ddd0d2220b977b5082"></a><br/></td></tr>
<tr class="memitem:a0de357471ad4a0535c9e82077ff606fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a0de357471ad4a0535c9e82077ff606fd">Create</a> (const std::string &name)</td></tr>
<tr class="memdesc:a0de357471ad4a0535c9e82077ff606fd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a root node and selects it. <a href="#a0de357471ad4a0535c9e82077ff606fd"></a><br/></td></tr>
<tr class="memitem:ac65ec988dde2dfdf185152eee7d4bc12"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#ac65ec988dde2dfdf185152eee7d4bc12">WriteSelection</a> (std::ostream &os)</td></tr>
<tr class="memdesc:ac65ec988dde2dfdf185152eee7d4bc12"><td class="mdescLeft"> </td><td class="mdescRight">Dumps the selected node on the stream. <a href="#ac65ec988dde2dfdf185152eee7d4bc12"></a><br/></td></tr>
<tr class="memitem:a3b8133cd25c3c6b5a391fc3b8d0f09c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a3b8133cd25c3c6b5a391fc3b8d0f09c6">WriteDocument</a> (std::ostream &os)</td></tr>
<tr class="memdesc:a3b8133cd25c3c6b5a391fc3b8d0f09c6"><td class="mdescLeft"> </td><td class="mdescRight">Dumps the full document on the stream. <a href="#a3b8133cd25c3c6b5a391fc3b8d0f09c6"></a><br/></td></tr>
<tr class="memitem:a1fcf65a3727c1559542651b7d6129e17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a1fcf65a3727c1559542651b7d6129e17">DumpObject</a> (const <a class="el" href="classCLAM_1_1Component.html">Component</a> &component)</td></tr>
<tr class="memdesc:a1fcf65a3727c1559542651b7d6129e17"><td class="mdescLeft"> </td><td class="mdescRight">Holds the component DOM to the selected node. <a href="#a1fcf65a3727c1559542651b7d6129e17"></a><br/></td></tr>
<tr class="memitem:ae21d5556aa53c546c9934e8a85289982"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#ae21d5556aa53c546c9934e8a85289982">RestoreObject</a> (<a class="el" href="classCLAM_1_1Component.html">Component</a> &component)</td></tr>
<tr class="memdesc:ae21d5556aa53c546c9934e8a85289982"><td class="mdescLeft"> </td><td class="mdescRight">Restores the component from the selected node. <a href="#ae21d5556aa53c546c9934e8a85289982"></a><br/></td></tr>
<tr class="memitem:a8f2ffebd31f9a7c5d8257ba7c8b6e00d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a8f2ffebd31f9a7c5d8257ba7c8b6e00d">Select</a> (const std::string &path)</td></tr>
<tr class="memdesc:a8f2ffebd31f9a7c5d8257ba7c8b6e00d"><td class="mdescLeft"> </td><td class="mdescRight">Moves the node selection to the specified path. <a href="#a8f2ffebd31f9a7c5d8257ba7c8b6e00d"></a><br/></td></tr>
<tr class="memitem:a691406cb4426e96f58735f6dbe905b83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a691406cb4426e96f58735f6dbe905b83">UseIndentation</a> (bool useIndentation)</td></tr>
<tr class="memdesc:a691406cb4426e96f58735f6dbe905b83"><td class="mdescLeft"> </td><td class="mdescRight">Changes whether to output pretty formated XML or not. <a href="#a691406cb4426e96f58735f6dbe905b83"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Interface for Components to load/store their subitems</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>This is the interface to be used by the <a class="el" href="classCLAM_1_1Component.html#a0df182236187947adaa614b13b2d27da" title="Stores component's subitems on the given Storage.">CLAM::Component::StoreOn</a> and <a class="el" href="classCLAM_1_1Component.html#a5a98bcb69bf85797845a8ac16c29584f" title="Loads component's subitems from the given Storage.">CLAM::Component::LoadFrom</a> implementers. </p>
</div></td></tr>
<tr class="memitem:a2861c3f944f0b4f2f84fc63705a623a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a2861c3f944f0b4f2f84fc63705a623a8">Store</a> (const <a class="el" href="classCLAM_1_1Storable.html">Storable</a> &storable)</td></tr>
<tr class="memdesc:a2861c3f944f0b4f2f84fc63705a623a8"><td class="mdescLeft"> </td><td class="mdescRight">Components should use that function in their LoadFrom in order to store their subitems wrapped with XML*Adapters. <a href="#a2861c3f944f0b4f2f84fc63705a623a8"></a><br/></td></tr>
<tr class="memitem:ab554944527210fffc6093aa7c16b09e1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#ab554944527210fffc6093aa7c16b09e1">Load</a> (<a class="el" href="classCLAM_1_1Storable.html">Storable</a> &storable)</td></tr>
<tr class="memdesc:ab554944527210fffc6093aa7c16b09e1"><td class="mdescLeft"> </td><td class="mdescRight">Components should use that function in their LoadFrom in order to load their subitems wrapped with XML*Adapters. <a href="#ab554944527210fffc6093aa7c16b09e1"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classCLAM_1_1Storage"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCLAM_1_1Storage')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCLAM_1_1Storage.html">CLAM::Storage</a></td></tr>
<tr class="memitem:ab73f415d1d4399fbd022a2f40525adeb inherit pub_methods_classCLAM_1_1Storage"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1Storage.html#ab73f415d1d4399fbd022a2f40525adeb">~Storage</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Summary operations to Dump and Restore</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Those operations are the simplest ones to use to dump and restore your objects in XML.</p>
<p><a class="el" href="group__XmlDump.html">XmlDump Module </a> </p>
</div></td></tr>
<tr class="memitem:a67bcef33fd2382092c34148012444798"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a67bcef33fd2382092c34148012444798">Dump</a> (const <a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, const std::string &rootName, std::ostream &os, bool indentate=true)</td></tr>
<tr class="memdesc:a67bcef33fd2382092c34148012444798"><td class="mdescLeft"> </td><td class="mdescRight">Dumps a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> as XML onto the named file with name as the root element. <a href="#a67bcef33fd2382092c34148012444798"></a><br/></td></tr>
<tr class="memitem:a15974b87a288e26476ae0a40845ad1b4"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a15974b87a288e26476ae0a40845ad1b4">Restore</a> (<a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, std::istream &is)</td></tr>
<tr class="memdesc:a15974b87a288e26476ae0a40845ad1b4"><td class="mdescLeft"> </td><td class="mdescRight">Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the given istream. <a href="#a15974b87a288e26476ae0a40845ad1b4"></a><br/></td></tr>
<tr class="memitem:a1b5e7c5185099fafa0ab46075e203f13"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a1b5e7c5185099fafa0ab46075e203f13">RestoreFromFragment</a> (<a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, const std::string &path, std::istream &is)</td></tr>
<tr class="memdesc:a1b5e7c5185099fafa0ab46075e203f13"><td class="mdescLeft"> </td><td class="mdescRight">Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the xml fragment on the given xpath of the given document. <a href="#a1b5e7c5185099fafa0ab46075e203f13"></a><br/></td></tr>
<tr class="memitem:ae1e35e061ca73c8d865a143dd13edc5a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#ae1e35e061ca73c8d865a143dd13edc5a">AppendToDocument</a> (const <a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, const std::string &xpath, const std::string &filename)</td></tr>
<tr class="memdesc:ae1e35e061ca73c8d865a143dd13edc5a"><td class="mdescLeft"> </td><td class="mdescRight">Append the xml fragment corresponding to the given component on the given xpath of an existing file. <a href="#ae1e35e061ca73c8d865a143dd13edc5a"></a><br/></td></tr>
<tr class="memitem:a49ec8283e5f396b5853a369ffab459ed"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a49ec8283e5f396b5853a369ffab459ed">Dump</a> (const <a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, const std::string &rootName, const std::string &filename)</td></tr>
<tr class="memdesc:a49ec8283e5f396b5853a369ffab459ed"><td class="mdescLeft"> </td><td class="mdescRight">Dump a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the named XML file. <a href="#a49ec8283e5f396b5853a369ffab459ed"></a><br/></td></tr>
<tr class="memitem:a02f56e9862ce77b004321fa13ac1c8de"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1XmlStorage.html#a02f56e9862ce77b004321fa13ac1c8de">Restore</a> (<a class="el" href="classCLAM_1_1Component.html">Component</a> &obj, const std::string &filename)</td></tr>
<tr class="memdesc:a02f56e9862ce77b004321fa13ac1c8de"><td class="mdescLeft"> </td><td class="mdescRight">Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the named XML file. <a href="#a02f56e9862ce77b004321fa13ac1c8de"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides XML format storage for <a class="el" href="namespaceCLAM.html">CLAM</a> <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a>'s. </p>
<p>Any class that derives from <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> can be dumped and restored in XML (<a href="http://www.w3.org/XML">http://www.w3.org/XML</a>) format. Components includes Arrays, <a class="el" href="classCLAM_1_1DynamicType.html" title="This class implements a type that is dynamic.">DynamicType</a>, <a class="el" href="classCLAM_1_1ProcessingConfig.html" title="This is an abstract class which serves as interface for configuration classes used as processing obje...">ProcessingConfig</a>, <a class="el" href="classCLAM_1_1ProcessingData.html" title="Interface classe for every concrete processing data (data that flows through the processing objs...">ProcessingData</a>...</p>
<dl class="section warning"><dt>Warning:</dt><dd>XML storage is a very expensive task when dealing with big amounts of numeric data.</dd></dl>
<h1><a class="anchor" id="XMLStaticInterface"></a>
Dumping and restoring a component in XML</h1>
<p>In its simplest usage, you can use the static functions Dump and Restore. </p>
<div class="fragment"><div class="line"> MyComponent myComponent;</div>
<div class="line"></div>
<div class="line"> <span class="comment">// Here you can modify your Component</span></div>
<div class="line"></div>
<div class="line"> <a class="code" href="classCLAM_1_1XmlStorage.html#a67bcef33fd2382092c34148012444798" title="Dumps a Component as XML onto the named file with name as the root element.">CLAM::XmlStorage::Dump</a>(myComponent, <span class="stringliteral">"Document"</span>, <span class="stringliteral">"MyComponent.xml"</span>)</div>
</div><!-- fragment --><p>Later you can restore the component: </p>
<div class="fragment"><div class="line"> <span class="comment">// An unmodified default constructed object!!!</span></div>
<div class="line"> MyComponent comp;</div>
<div class="line"> <span class="keywordflow">try</span></div>
<div class="line"> {</div>
<div class="line"> <a class="code" href="classCLAM_1_1XmlStorage.html#a15974b87a288e26476ae0a40845ad1b4" title="Restore a Component from the given istream.">CLAM::XmlStorage::Restore</a>(comp, <span class="stringliteral">"mycomponent.xml"</span>);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">catch</span> (<a class="code" href="classCLAM_1_1XmlStorageErr.html">CLAM::XmlStorageErr</a> & err)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// Handle the error, a dirty way could be:</span></div>
<div class="line"> std::cerr << err.<a class="code" href="classCLAM_1_1XmlStorageErr.html#ae0a37ceefcf581556c9aef4a977d777f">what</a>() << std::endl;</div>
<div class="line"> exit(-1);</div>
<div class="line"> }</div>
</div><!-- fragment --><p>Dump and Restore are overloaded to accept any C++ stream instead of a filename.</p>
<p>You can the AppendToDocument static function to add an object in a given path of an existing XML file, or using RestoreFromFragment to restore the object taking an XML fragment.</p>
<h1><a class="anchor" id="XmlStepByStepInterface"></a>
Step-By-Step Interface</h1>
<p>The XMLStorage static methods used above provide shortcuts for the widely used funcionalities. The non-static methods that XMLStorage provides are the building blocks for implementing the static ones:</p>
<ul>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#a0de357471ad4a0535c9e82077ff606fd" title="Creates a root node and selects it.">XmlStorage::Create</a>: Creates an Empty DOM document.</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#ac17ba04364d737ddd0d2220b977b5082" title="Loads the DOM from the stream and selects the root node.">XmlStorage::Read</a>: Creates a DOM document from the XML that comps from an istream.</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#a3b8133cd25c3c6b5a391fc3b8d0f09c6" title="Dumps the full document on the stream.">XmlStorage::WriteDocument</a>: Writes on a stream the whole document</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#a8f2ffebd31f9a7c5d8257ba7c8b6e00d" title="Moves the node selection to the specified path.">XmlStorage::Select</a>: Changes the selected node (by default the root is selected)</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#ac65ec988dde2dfdf185152eee7d4bc12" title="Dumps the selected node on the stream.">XmlStorage::WriteSelection</a>: Writes on a stream the selected target</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#a1fcf65a3727c1559542651b7d6129e17" title="Holds the component DOM to the selected node.">XmlStorage::DumpObject</a>: Dumps the <a class="el" href="namespaceCLAM.html">CLAM</a> object on the selected DOM node</li>
<li><a class="el" href="classCLAM_1_1XmlStorage.html#ae21d5556aa53c546c9934e8a85289982" title="Restores the component from the selected node.">XmlStorage::RestoreObject</a>: Restores the <a class="el" href="namespaceCLAM.html">CLAM</a> object from the selected DOM node</li>
</ul>
<p>You can convining them to achieve a diferent behaviour.</p>
<ul>
<li>storing optimally the same object it onto two different streams, <div class="fragment"><div class="line"> <a class="code" href="classCLAM_1_1XmlStorage.html" title="Provides XML format storage for CLAM Component's.">CLAM::XmlStorage</a> storage;</div>
<div class="line"> storage.<a class="code" href="classCLAM_1_1XmlStorage.html#a0de357471ad4a0535c9e82077ff606fd" title="Creates a root node and selects it.">Create</a>(<span class="stringliteral">"Document"</span>);</div>
<div class="line"> storage.<a class="code" href="classCLAM_1_1XmlStorage.html#a1fcf65a3727c1559542651b7d6129e17" title="Holds the component DOM to the selected node.">DumpObject</a>(component);</div>
<div class="line"> <span class="comment">// Writting it to a file</span></div>
<div class="line"> std::ofstream os(<span class="stringliteral">"Document.xml"</span>);</div>
<div class="line"> storage.<a class="code" href="classCLAM_1_1XmlStorage.html#a3b8133cd25c3c6b5a391fc3b8d0f09c6" title="Dumps the full document on the stream.">WriteDocument</a>(os);</div>
<div class="line"> <span class="comment">// Writting it to the standard output</span></div>
<div class="line"> storage.<a class="code" href="classCLAM_1_1XmlStorage.html#a3b8133cd25c3c6b5a391fc3b8d0f09c6" title="Dumps the full document on the stream.">WriteDocument</a>(std::cout);</div>
</div><!-- fragment --></li>
<li>updating an existing xml by adding some objects to it,</li>
<li>extracting an object from a part of a document,</li>
<li>writing a document fragment</li>
<li>...</li>
</ul>
<p>Static methods are not enough, but you still can instantiate an XMLStorage object and use the non-static methods with it. Non-static methods implements smaller steps than static methods do and you can combine them in order to obtain some concrete behaviour. For example, if you want to update an xml document by adding an object on XPath /Doc/element/subElement, you can use the sequence Read-Select-DumpObject-WriteDocument.</p>
<dl class="section author"><dt>Author:</dt><dd>David Garcia. </dd></dl>
<p>Definition at line <a class="el" href="XMLStorage_8hxx_source.html#l00044">44</a> of file <a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abcb6623c19b0ad0191235a4fce7b5bcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CLAM::XmlStorage::XmlStorage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00100">100</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00043">CLAM::NullDomDocumentHandler::SetReadingContext()</a>, and <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00051">CLAM::NullDomDocumentHandler::SetWritingContext()</a>.</p>
</div>
</div>
<a class="anchor" id="a9a57a1831af9371ce0144a3e19e2f89f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CLAM::XmlStorage::~XmlStorage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00108">108</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae1e35e061ca73c8d865a143dd13edc5a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::AppendToDocument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>xpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Append the xml fragment corresponding to the given component on the given xpath of an existing file. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00129">129</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="XMLStorage_8cxx_source.html#l00072">DumpObject()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00051">Read()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00090">Select()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00067">WriteDocument()</a>.</p>
</div>
</div>
<a class="anchor" id="a0de357471ad4a0535c9e82077ff606fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Create </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a root node and selects it. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00056">56</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00069">CLAM::NullDomDocumentHandler::create()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8hxx_source.html#l00103">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a67bcef33fd2382092c34148012444798"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CLAM::XmlStorage::Dump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>rootName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>indentate</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dumps a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> as XML onto the named file with name as the root element. </p>
<p>Definition at line <a class="el" href="XMLStorage_8hxx_source.html#l00103">103</a> of file <a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a>.</p>
<p>References <a class="el" href="XMLStorage_8cxx_source.html#l00056">Create()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00072">DumpObject()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00095">UseIndentation()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00067">WriteDocument()</a>.</p>
<p>Referenced by <a class="el" href="ControlTrace_8cxx_source.html#l00239">CLAM::ControlTraceWriter::ConcreteStop()</a>, <a class="el" href="DynamicType_8cxx_source.html#l00823">CLAM::DynamicType::Debug()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00122">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a49ec8283e5f396b5853a369ffab459ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Dump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>rootName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the named XML file. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00122">122</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="Assert_8hxx_source.html#l00158">CLAM_WARNING</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00103">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a1fcf65a3727c1559542651b7d6129e17"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::DumpObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>component</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds the component DOM to the selected node. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00072">72</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00051">CLAM::NullDomDocumentHandler::SetWritingContext()</a>, and <a class="el" href="classCLAM_1_1Component.html#a0df182236187947adaa614b13b2d27da">CLAM::Component::StoreOn()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8cxx_source.html#l00129">AppendToDocument()</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00103">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="ab554944527210fffc6093aa7c16b09e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool CLAM::XmlStorage::Load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Storable.html">Storable</a> & </td>
<td class="paramname"><em>storable</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Components should use that function in their LoadFrom in order to load their subitems wrapped with XML*Adapters. </p>
<p>Implements <a class="el" href="classCLAM_1_1Storage.html#a47040ce330c31a8af99e8db8b00022eb">CLAM::Storage</a>.</p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00174">174</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="Assert_8hxx_source.html#l00153">CLAM_ASSERT</a>, <a class="el" href="NullDomReadingContext_8hxx_source.html#l00066">CLAM::NullDomReadingContext::extractAttribute()</a>, <a class="el" href="NullDomReadingContext_8hxx_source.html#l00056">CLAM::NullDomReadingContext::findElement()</a>, <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00039">CLAM::NullDomDocumentHandler::GetReadingContext()</a>, <a class="el" href="classCLAM_1_1XMLable.html#ae4b232a2b80d8dd5d7e3d0d0997e7ee9">CLAM::XMLable::IsXMLAttribute()</a>, <a class="el" href="classCLAM_1_1XMLable.html#a24f4f4b60e6d5ef4203a87fb15c801bf">CLAM::XMLable::IsXMLElement()</a>, <a class="el" href="classCLAM_1_1XMLable.html#a9b53c31117dd4221b4b58574a5c00ded">CLAM::XMLable::IsXMLText()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00041">CLAM::join()</a>, <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00043">CLAM::NullDomDocumentHandler::SetReadingContext()</a>, <a class="el" href="classCLAM_1_1XMLable.html#afaf62acda5b15c53cb737cfc1c1c39de">CLAM::XMLable::XMLContent()</a>, and <a class="el" href="classCLAM_1_1XMLable.html#a68a124908f150b4ea7aa8a395f39e6a3">CLAM::XMLable::XMLName()</a>.</p>
</div>
</div>
<a class="anchor" id="ac17ba04364d737ddd0d2220b977b5082"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Read </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>is</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the DOM from the stream and selects the root node. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00051">51</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00072">CLAM::NullDomDocumentHandler::read()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8cxx_source.html#l00129">AppendToDocument()</a>, <a class="el" href="XMLStorage_8hxx_source.html#l00115">Restore()</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00125">RestoreFromFragment()</a>.</p>
</div>
</div>
<a class="anchor" id="a15974b87a288e26476ae0a40845ad1b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CLAM::XmlStorage::Restore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>is</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the given istream. </p>
<p>Definition at line <a class="el" href="XMLStorage_8hxx_source.html#l00115">115</a> of file <a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a>.</p>
<p>References <a class="el" href="XMLStorage_8cxx_source.html#l00051">Read()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00079">RestoreObject()</a>.</p>
<p>Referenced by <a class="el" href="ControlTrace_8cxx_source.html#l00282">CLAM::ControlTraceReader::ConcreteConfigure()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00113">Restore()</a>.</p>
</div>
</div>
<a class="anchor" id="a02f56e9862ce77b004321fa13ac1c8de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Restore </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the named XML file. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00113">113</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="Assert_8hxx_source.html#l00158">CLAM_WARNING</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00115">Restore()</a>.</p>
</div>
</div>
<a class="anchor" id="a1b5e7c5185099fafa0ab46075e203f13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void CLAM::XmlStorage::RestoreFromFragment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>is</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restore a <a class="el" href="classCLAM_1_1Component.html" title="Abstract class for objects that can have subitems to be stored on a storage.">Component</a> from the xml fragment on the given xpath of the given document. </p>
<p>Definition at line <a class="el" href="XMLStorage_8hxx_source.html#l00125">125</a> of file <a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a>.</p>
<p>References <a class="el" href="XMLStorage_8cxx_source.html#l00051">Read()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00079">RestoreObject()</a>, and <a class="el" href="XMLStorage_8cxx_source.html#l00090">Select()</a>.</p>
</div>
</div>
<a class="anchor" id="ae21d5556aa53c546c9934e8a85289982"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::RestoreObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Component.html">Component</a> & </td>
<td class="paramname"><em>component</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restores the component from the selected node. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00079">79</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomReadingContext_8hxx_source.html#l00076">CLAM::NullDomReadingContext::errors()</a>, <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00039">CLAM::NullDomDocumentHandler::GetReadingContext()</a>, <a class="el" href="XMLStorage_8cxx_source.html#l00041">CLAM::join()</a>, <a class="el" href="classCLAM_1_1Component.html#a5a98bcb69bf85797845a8ac16c29584f">CLAM::Component::LoadFrom()</a>, <a class="el" href="NullDomReadingContext_8hxx_source.html#l00061">CLAM::NullDomReadingContext::release()</a>, and <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00043">CLAM::NullDomDocumentHandler::SetReadingContext()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8hxx_source.html#l00115">Restore()</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00125">RestoreFromFragment()</a>.</p>
</div>
</div>
<a class="anchor" id="a8f2ffebd31f9a7c5d8257ba7c8b6e00d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Select </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves the node selection to the specified path. </p>
<dl class="exception"><dt>Exceptions:</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCLAM_1_1XmlStorageErr.html">XmlStorageErr</a></td><td>whenever a step is not found The path is a subset of XPath. Absolute and relative paths can be used but node names are the only step specifier to be used.</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"> /Root/Element/SubElement</div>
<div class="line"> Element/SubElement <span class="comment">// Relative being in /Root, the default)</span></div>
<div class="line"> / <span class="comment">// Equivalent to /Root but useful when </span></div>
<div class="line"> <span class="comment">// you don't know the root node name.</span></div>
</div><!-- fragment --><p> Sets the selection at the specified path (the default selection is the root node) </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00090">90</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00066">CLAM::NullDomDocumentHandler::selectPath()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8cxx_source.html#l00129">AppendToDocument()</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00125">RestoreFromFragment()</a>.</p>
</div>
</div>
<a class="anchor" id="a2861c3f944f0b4f2f84fc63705a623a8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::Store </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Storable.html">Storable</a> & </td>
<td class="paramname"><em>storable</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Components should use that function in their LoadFrom in order to store their subitems wrapped with XML*Adapters. </p>
<p>Implements <a class="el" href="classCLAM_1_1Storage.html#a3635ac06fce8025cccc23ea15fc85e4a">CLAM::Storage</a>.</p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00147">147</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomWritingContext_8hxx_source.html#l00056">CLAM::NullDomWritingContext::addAttribute()</a>, <a class="el" href="Assert_8hxx_source.html#l00153">CLAM_ASSERT</a>, <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00047">CLAM::NullDomDocumentHandler::GetWritingContext()</a>, <a class="el" href="classCLAM_1_1XMLable.html#ae4b232a2b80d8dd5d7e3d0d0997e7ee9">CLAM::XMLable::IsXMLAttribute()</a>, <a class="el" href="classCLAM_1_1XMLable.html#a24f4f4b60e6d5ef4203a87fb15c801bf">CLAM::XMLable::IsXMLElement()</a>, <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00051">CLAM::NullDomDocumentHandler::SetWritingContext()</a>, <a class="el" href="classCLAM_1_1XMLable.html#afaf62acda5b15c53cb737cfc1c1c39de">CLAM::XMLable::XMLContent()</a>, and <a class="el" href="classCLAM_1_1XMLable.html#a68a124908f150b4ea7aa8a395f39e6a3">CLAM::XMLable::XMLName()</a>.</p>
</div>
</div>
<a class="anchor" id="a691406cb4426e96f58735f6dbe905b83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::UseIndentation </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>useIndentation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes whether to output pretty formated XML or not. </p>
<p>By default, indentation and new lines are not inserted resulting in compact XML but dificult for humans to read. Use this method, to enable the indentation. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000055">Todo:</a></b></dt><dd>Not implemented yet </dd></dl>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00095">95</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8hxx_source.html#l00103">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="a3b8133cd25c3c6b5a391fc3b8d0f09c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::WriteDocument </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dumps the full document on the stream. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00067">67</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00075">CLAM::NullDomDocumentHandler::writeDocument()</a>.</p>
<p>Referenced by <a class="el" href="XMLStorage_8cxx_source.html#l00129">AppendToDocument()</a>, and <a class="el" href="XMLStorage_8hxx_source.html#l00103">Dump()</a>.</p>
</div>
</div>
<a class="anchor" id="ac65ec988dde2dfdf185152eee7d4bc12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CLAM::XmlStorage::WriteSelection </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dumps the selected node on the stream. </p>
<p>Definition at line <a class="el" href="XMLStorage_8cxx_source.html#l00062">62</a> of file <a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a>.</p>
<p>References <a class="el" href="NullDomDocumentHandler_8hxx_source.html#l00078">CLAM::NullDomDocumentHandler::writeSelection()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="XMLStorage_8hxx_source.html">XMLStorage.hxx</a></li>
<li><a class="el" href="XMLStorage_8cxx_source.html">XMLStorage.cxx</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
Cokiee Shell Web 1.0, Coded By Razor
Neueste Kommentare