Files
cereal/assets/doxygen/classcereal_1_1XMLInputArchive.html
T
2013-07-05 20:56:22 -07:00

266 lines
20 KiB
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"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>cereal: cereal::XMLInputArchive 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">cereal
</div>
<div id="projectbrief">A C++11 library for serialization</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>cereal</b></li><li class="navelem"><a class="el" href="classcereal_1_1XMLInputArchive.html">XMLInputArchive</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classcereal_1_1XMLInputArchive-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::XMLInputArchive Class Reference<div class="ingroups"><a class="el" href="group__Archives.html">Input and output archive types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>An output archive designed to save data to XML.
<a href="classcereal_1_1XMLInputArchive.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="xml_8hpp_source.html">cereal/archives/xml.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cereal::XMLInputArchive:</div>
<div class="dyncontent">
<div class="center">
<img src="classcereal_1_1XMLInputArchive.png" usemap="#cereal::XMLInputArchive_map" alt=""/>
<map id="cereal::XMLInputArchive_map" name="cereal::XMLInputArchive_map">
<area href="classcereal_1_1InputArchive.html" alt="cereal::InputArchive&lt; XMLInputArchive &gt;" shape="rect" coords="0,56,249,80"/>
<area href="structcereal_1_1detail_1_1InputArchiveBase.html" alt="cereal::detail::InputArchiveBase" shape="rect" coords="0,0,249,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1XMLInputArchive_1_1NodeInfo.html">NodeInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A struct that contains metadata about a node. <a href="structcereal_1_1XMLInputArchive_1_1NodeInfo.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab641ded4033d8e998e41dd002ece9184"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#ab641ded4033d8e998e41dd002ece9184">XMLInputArchive</a> (std::istream &amp;stream)</td></tr>
<tr class="memdesc:ab641ded4033d8e998e41dd002ece9184"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct, reading in from the provided stream. <a href="#ab641ded4033d8e998e41dd002ece9184">More...</a><br/></td></tr>
<tr class="separator:ab641ded4033d8e998e41dd002ece9184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c8399e6e6651126aaf5d38631c14d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96c8399e6e6651126aaf5d38631c14d0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#a96c8399e6e6651126aaf5d38631c14d0">startNode</a> ()</td></tr>
<tr class="memdesc:a96c8399e6e6651126aaf5d38631c14d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares to start reading the next node. <br/></td></tr>
<tr class="separator:a96c8399e6e6651126aaf5d38631c14d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f0c412f74f3b538efac94886005b44"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06f0c412f74f3b538efac94886005b44"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#a06f0c412f74f3b538efac94886005b44">finishNode</a> ()</td></tr>
<tr class="memdesc:a06f0c412f74f3b538efac94886005b44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finishes reading the current node. <br/></td></tr>
<tr class="separator:a06f0c412f74f3b538efac94886005b44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a26917ee5e5d8c6a16faa19593e461"><td class="memTemplParams" colspan="2"><a class="anchor" id="a60a26917ee5e5d8c6a16faa19593e461"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a60a26917ee5e5d8c6a16faa19593e461"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#a60a26917ee5e5d8c6a16faa19593e461">loadValue</a> (T &amp;value)</td></tr>
<tr class="memdesc:a60a26917ee5e5d8c6a16faa19593e461"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a value from the current node. <br/></td></tr>
<tr class="separator:a60a26917ee5e5d8c6a16faa19593e461"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5874ffacb2c44546e71819cc23f7040e"><td class="memTemplParams" colspan="2"><a class="anchor" id="a5874ffacb2c44546e71819cc23f7040e"></a>
template&lt;class CharT , class Traits , class Alloc &gt; </td></tr>
<tr class="memitem:a5874ffacb2c44546e71819cc23f7040e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#a5874ffacb2c44546e71819cc23f7040e">loadValue</a> (std::basic_string&lt; CharT, Traits, Alloc &gt; &amp;str)</td></tr>
<tr class="memdesc:a5874ffacb2c44546e71819cc23f7040e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a string from the current node. <br/></td></tr>
<tr class="separator:a5874ffacb2c44546e71819cc23f7040e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12a944a053ce82391c36bc72c126929f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#a12a944a053ce82391c36bc72c126929f">loadBinaryValue</a> (void *data, size_t size)</td></tr>
<tr class="memdesc:a12a944a053ce82391c36bc72c126929f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads some binary data, encoded as a base64 string. <a href="#a12a944a053ce82391c36bc72c126929f">More...</a><br/></td></tr>
<tr class="separator:a12a944a053ce82391c36bc72c126929f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9ed2b9bd88b279e999b4df1f3f129f8"><td class="memTemplParams" colspan="2"><a class="anchor" id="ad9ed2b9bd88b279e999b4df1f3f129f8"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:ad9ed2b9bd88b279e999b4df1f3f129f8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#ad9ed2b9bd88b279e999b4df1f3f129f8">loadSize</a> (T &amp;value)</td></tr>
<tr class="memdesc:ad9ed2b9bd88b279e999b4df1f3f129f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads the size of the current node. <br/></td></tr>
<tr class="separator:ad9ed2b9bd88b279e999b4df1f3f129f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcereal_1_1InputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1InputArchive')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive&lt; XMLInputArchive &gt;</a></td></tr>
<tr class="memitem:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a32c533e57346373d3600e02d1e47fdbf">InputArchive</a> (<a class="el" href="classcereal_1_1XMLInputArchive.html">XMLInputArchive</a> *const self)</td></tr>
<tr class="memdesc:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the output archive. <a href="#a32c533e57346373d3600e02d1e47fdbf">More...</a><br/></td></tr>
<tr class="separator:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a248a3bc0b5d34877a267ab6e23241cf6"></a>
<a class="el" href="classcereal_1_1XMLInputArchive.html">XMLInputArchive</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a248a3bc0b5d34877a267ab6e23241cf6">operator()</a> (Types &amp;&amp;...args)</td></tr>
<tr class="memdesc:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all passed in data. <br/></td></tr>
<tr class="separator:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; void &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a27251df805e938bd528dd680c2df5a47">getSharedPointer</a> (std::uint32_t const id)</td></tr>
<tr class="memdesc:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a shared pointer given a unique key for it. <a href="#a27251df805e938bd528dd680c2df5a47">More...</a><br/></td></tr>
<tr class="separator:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a5a8c43c2803faa0b78cfb42e10c91d93">registerSharedPointer</a> (std::uint32_t const id, std::shared_ptr&lt; void &gt; ptr)</td></tr>
<tr class="memdesc:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a shared pointer to its unique identifier. <a href="#a5a8c43c2803faa0b78cfb42e10c91d93">More...</a><br/></td></tr>
<tr class="separator:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a2d39247b893f26eecc863a7b321e6a00">getPolymorphicName</a> (std::uint32_t const id)</td></tr>
<tr class="memdesc:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the string for a polymorphic type given a unique key for it. <a href="#a2d39247b893f26eecc863a7b321e6a00">More...</a><br/></td></tr>
<tr class="separator:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#ae6602c484b49376ad1c392719d02ef56">registerPolymorphicName</a> (std::uint32_t const id, std::string const &amp;name)</td></tr>
<tr class="memdesc:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a polymorphic name string to its unique identifier. <a href="#ae6602c484b49376ad1c392719d02ef56">More...</a><br/></td></tr>
<tr class="separator:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aea4f24d0abcecddf5669b3406d875379"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea4f24d0abcecddf5669b3406d875379"></a>
static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLInputArchive.html#aea4f24d0abcecddf5669b3406d875379">getNumChildren</a> (<a class="el" href="classrapidxml_1_1xml__node.html">rapidxml::xml_node</a>&lt;&gt; *node=nullptr)</td></tr>
<tr class="memdesc:aea4f24d0abcecddf5669b3406d875379"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of children (usually interpreted as size) for the specified node. <br/></td></tr>
<tr class="separator:aea4f24d0abcecddf5669b3406d875379"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An output archive designed to save data to XML. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab641ded4033d8e998e41dd002ece9184"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cereal::XMLInputArchive::XMLInputArchive </td>
<td>(</td>
<td class="paramtype">std::istream &amp;&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct, reading in from the provided stream. </p>
<p>Reads in an entire XML document from some stream and parses it as soon as serialization starts</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>The stream to read from. Can be a stringstream or a file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a12a944a053ce82391c36bc72c126929f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void cereal::XMLInputArchive::loadBinaryValue </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads some binary data, encoded as a base64 string. </p>
<p>This will automatically start and finish a node to load the data </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/cereal/archives/<a class="el" href="xml_8hpp_source.html">xml.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 5 2013 20:54:19 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>