phynexis-deps/cereal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
df875c0b60b4e5b75bfa321bbcf97e5a8a239f89
cereal/assets/doxygen/classcereal_1_1InputArchive.html
T
Randolph Voorhies 97418f29f8 Adding doxygen
2013-07-05 20:56:22 -07:00

362 lines
18 KiB
HTML
Raw Blame History

<!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::InputArchive&lt; ArchiveType, Flags &gt; Class Template 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_1InputArchive.html">InputArchive</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcereal_1_1InputArchive-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::InputArchive&lt; ArchiveType, Flags &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The base input archive class.
<a href="classcereal_1_1InputArchive.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="cereal_8hpp_source.html">cereal/cereal.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cereal::InputArchive&lt; ArchiveType, Flags &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classcereal_1_1InputArchive.png" usemap="#cereal::InputArchive&lt; ArchiveType, Flags &gt;_map" alt=""/>
<map id="cereal::InputArchive&lt; ArchiveType, Flags &gt;_map" name="cereal::InputArchive&lt; ArchiveType, Flags &gt;_map">
<area href="structcereal_1_1detail_1_1InputArchiveBase.html" alt="cereal::detail::InputArchiveBase" shape="rect" coords="0,0,263,24"/>
</map>
</div></div>
<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:a32c533e57346373d3600e02d1e47fdbf"><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> (ArchiveType *const self)</td></tr>
<tr class="memdesc:a32c533e57346373d3600e02d1e47fdbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the output archive. <a href="#a32c533e57346373d3600e02d1e47fdbf">More...</a><br/></td></tr>
<tr class="separator:a32c533e57346373d3600e02d1e47fdbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a248a3bc0b5d34877a267ab6e23241cf6"><td class="memTemplParams" colspan="2"><a class="anchor" id="a248a3bc0b5d34877a267ab6e23241cf6"></a>
template&lt;class... Types&gt; </td></tr>
<tr class="memitem:a248a3bc0b5d34877a267ab6e23241cf6"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a248a3bc0b5d34877a267ab6e23241cf6">operator()</a> (Types &amp;&amp;...args)</td></tr>
<tr class="memdesc:a248a3bc0b5d34877a267ab6e23241cf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all passed in data. <br/></td></tr>
<tr class="separator:a248a3bc0b5d34877a267ab6e23241cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27251df805e938bd528dd680c2df5a47"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a8c43c2803faa0b78cfb42e10c91d93"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d39247b893f26eecc863a7b321e6a00"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6602c484b49376ad1c392719d02ef56"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class ArchiveType, std::uint32_t Flags = 0&gt;<br/>
class cereal::InputArchive&lt; ArchiveType, Flags &gt;</h3>
<p>The base input archive class. </p>
<p>This is the base input archive for all input archives. If you create a custom archive class, it should derive from this, passing itself as a template parameter for the ArchiveType.</p>
<p>The base class provides all of the functionality necessary to properly forward data to the correct serialization functions.</p>
<p>Individual archives should use a combination of prologue and epilogue functions together with specializations of serialize, save, and load to alter the functionality of their serialization.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ArchiveType</td><td>The archive type that derives from <a class="el" href="classcereal_1_1InputArchive.html" title="The base input archive class.">InputArchive</a> </td></tr>
<tr><td class="paramname">Flags</td><td>Flags to control advanced functionality. See the Flags enum for more information. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a32c533e57346373d3600e02d1e47fdbf"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType, std::uint32_t Flags = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, Flags &gt;::<a class="el" href="classcereal_1_1InputArchive.html">InputArchive</a> </td>
<td>(</td>
<td class="paramtype">ArchiveType *const&#160;</td>
<td class="paramname"><em>self</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 the output archive. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">self</td><td>A pointer to the derived ArchiveType (pass this from the derived archive) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2d39247b893f26eecc863a7b321e6a00"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType, std::uint32_t Flags = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, Flags &gt;::getPolymorphicName </td>
<td>(</td>
<td class="paramtype">std::uint32_t const&#160;</td>
<td class="paramname"><em>id</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>Retrieves the string for a polymorphic type given a unique key for it. </p>
<p>This is used to retrieve a string previously registered during a polymorphic load.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The unique id that was serialized for the polymorphic type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The string identifier for the tyep </dd></dl>
</div>
</div>
<a class="anchor" id="a27251df805e938bd528dd680c2df5a47"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType, std::uint32_t Flags = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt;void&gt; <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, Flags &gt;::getSharedPointer </td>
<td>(</td>
<td class="paramtype">std::uint32_t const&#160;</td>
<td class="paramname"><em>id</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>Retrieves a shared pointer given a unique key for it. </p>
<p>This is used to retrieve a previously registered shared_ptr which has already been loaded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The unique id that was serialized for the pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the data </dd></dl>
</div>
</div>
<a class="anchor" id="ae6602c484b49376ad1c392719d02ef56"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType, std::uint32_t Flags = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, Flags &gt;::registerPolymorphicName </td>
<td>(</td>
<td class="paramtype">std::uint32_t const&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string const &amp;&#160;</td>
<td class="paramname"><em>name</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>Registers a polymorphic name string to its unique identifier. </p>
<p>After a polymorphic type has been loaded for the first time, it should be registered with its loaded id for future references to it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The unique identifier for the polymorphic type </td></tr>
<tr><td class="paramname">name</td><td>The name associated with the tyep </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5a8c43c2803faa0b78cfb42e10c91d93"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType, std::uint32_t Flags = 0&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, Flags &gt;::registerSharedPointer </td>
<td>(</td>
<td class="paramtype">std::uint32_t const&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::shared_ptr&lt; void &gt;&#160;</td>
<td class="paramname"><em>ptr</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>Registers a shared pointer to its unique identifier. </p>
<p>After a shared pointer has been loaded for the first time, it should be registered with its loaded id for future references to it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The unique identifier for the shared pointer </td></tr>
<tr><td class="paramname">ptr</td><td>The actual shared pointer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/cereal/<a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 5 2013 20:54:20 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>
Reference in New Issue View Git Blame Copy Permalink