generic-library/cereal
1
0
Fork 0
mirror of https://github.com/USCiLab/cereal.git synced 2025-07-21 02:22:01 +02:00
Code Issues Projects Releases Wiki Activity
cereal/assets/doxygen/classcereal_1_1InputArchive.html
Shane Grant bf9fc8231e Update doc for 132
2022-02-27 19:48:38 -08:00

540 lines
32 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=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/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="#friends">Friends</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 class="ingroups"><a class="el" href="group__Internal.html">Internal Functionality</a></div></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">/home/shane/workspace/cereal/include/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_3C_20ArchiveType_2C_20Flags_20_3E_map" alt=""/>
<map id="cereal::InputArchive_3C_20ArchiveType_2C_20Flags_20_3E_map" name="cereal::InputArchive_3C_20ArchiveType_2C_20Flags_20_3E_map">
<area href="classcereal_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:a76455fba49795d1676664f634918c580"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a76455fba49795d1676664f634918c580">InputArchive</a> (ArchiveType *const derived)</td></tr>
<tr class="memdesc:a76455fba49795d1676664f634918c580"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the output archive. <a href="classcereal_1_1InputArchive.html#a76455fba49795d1676664f634918c580">More...</a><br /></td></tr>
<tr class="separator:a76455fba49795d1676664f634918c580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1878bd30caccaf495bcb5062756559a4"><td class="memItemLeft" align="right" valign="top"><a id="a1878bd30caccaf495bcb5062756559a4"></a>
<a class="el" href="classcereal_1_1InputArchive.html">InputArchive</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1InputArchive.html">InputArchive</a> const &amp;)=delete</td></tr>
<tr class="separator:a1878bd30caccaf495bcb5062756559a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21bf0587ab9749e2afde4bb51d8988ec"><td class="memTemplParams" colspan="2">template&lt;class ... Types&gt; </td></tr>
<tr class="memitem:a21bf0587ab9749e2afde4bb51d8988ec"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a21bf0587ab9749e2afde4bb51d8988ec">operator()</a> (Types &amp;&amp;... args)</td></tr>
<tr class="memdesc:a21bf0587ab9749e2afde4bb51d8988ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all passed in data. <a href="classcereal_1_1InputArchive.html#a21bf0587ab9749e2afde4bb51d8988ec">More...</a><br /></td></tr>
<tr class="separator:a21bf0587ab9749e2afde4bb51d8988ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a846b9482bf620966e2fa91921251a307"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a846b9482bf620966e2fa91921251a307">serializeDeferments</a> ()</td></tr>
<tr class="memdesc:a846b9482bf620966e2fa91921251a307"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes any data marked for deferment using defer. <a href="classcereal_1_1InputArchive.html#a846b9482bf620966e2fa91921251a307">More...</a><br /></td></tr>
<tr class="separator:a846b9482bf620966e2fa91921251a307"><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="classcereal_1_1InputArchive.html#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="classcereal_1_1InputArchive.html#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="classcereal_1_1InputArchive.html#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="classcereal_1_1InputArchive.html#ae6602c484b49376ad1c392719d02ef56">More...</a><br /></td></tr>
<tr class="separator:ae6602c484b49376ad1c392719d02ef56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1detail_1_1InputArchiveBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">cereal::detail::InputArchiveBase</a></td></tr>
<tr class="memitem:a6c3165c8d75cc83037a6f25c5d3bf3d4 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a6c3165c8d75cc83037a6f25c5d3bf3d4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>InputArchiveBase</b> (<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:a6c3165c8d75cc83037a6f25c5d3bf3d4 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b543080f3f5717657f36cee95450357 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a7b543080f3f5717657f36cee95450357"></a>
<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:a7b543080f3f5717657f36cee95450357 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a41750b871b4e635565f892e4abfb20b0"><td class="memTemplParams" colspan="2"><a id="a41750b871b4e635565f892e4abfb20b0"></a>
template&lt;class A , class B , bool C, bool D, bool E, bool F&gt; </td></tr>
<tr class="memitem:a41750b871b4e635565f892e4abfb20b0"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a41750b871b4e635565f892e4abfb20b0">detail::Construct</a></td></tr>
<tr class="memdesc:a41750b871b4e635565f892e4abfb20b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Befriend for versioning in load_and_construct. <br /></td></tr>
<tr class="separator:a41750b871b4e635565f892e4abfb20b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Boost Transition Layer</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpb9b9c12dd3c33d78e200b2be3cbe592c"></a>Functionality that mirrors the syntax for Boost. This is useful if you are transitioning a large project from Boost to cereal. The preferred interface for cereal is using operator(). </p>
</td></tr>
<tr class="memitem:adeb555e9b25f21391e4cc9eca9f04dbd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#adeb555e9b25f21391e4cc9eca9f04dbd">is_loading</a> = std::true_type</td></tr>
<tr class="memdesc:adeb555e9b25f21391e4cc9eca9f04dbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates this archive is intended for loading. <a href="classcereal_1_1InputArchive.html#adeb555e9b25f21391e4cc9eca9f04dbd">More...</a><br /></td></tr>
<tr class="separator:adeb555e9b25f21391e4cc9eca9f04dbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af90a8d1dc2c9163367765817f7b704d4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#af90a8d1dc2c9163367765817f7b704d4">is_saving</a> = std::false_type</td></tr>
<tr class="memdesc:af90a8d1dc2c9163367765817f7b704d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates this archive is not intended for saving. <a href="classcereal_1_1InputArchive.html#af90a8d1dc2c9163367765817f7b704d4">More...</a><br /></td></tr>
<tr class="separator:af90a8d1dc2c9163367765817f7b704d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c7141a24a934978b1ef9894215e67f"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a88c7141a24a934978b1ef9894215e67f"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a88c7141a24a934978b1ef9894215e67f">operator&amp;</a> (T &amp;&amp;arg)</td></tr>
<tr class="memdesc:a88c7141a24a934978b1ef9894215e67f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1InputArchive.html#a88c7141a24a934978b1ef9894215e67f">More...</a><br /></td></tr>
<tr class="separator:a88c7141a24a934978b1ef9894215e67f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe460125bb5603ae92517d21d2733491"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:abe460125bb5603ae92517d21d2733491"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#abe460125bb5603ae92517d21d2733491">operator&gt;&gt;</a> (T &amp;&amp;arg)</td></tr>
<tr class="memdesc:abe460125bb5603ae92517d21d2733491"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1InputArchive.html#abe460125bb5603ae92517d21d2733491">More...</a><br /></td></tr>
<tr class="separator:abe460125bb5603ae92517d21d2733491"><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">Member Typedef Documentation</h2>
<a id="adeb555e9b25f21391e4cc9eca9f04dbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeb555e9b25f21391e4cc9eca9f04dbd">&#9670;&nbsp;</a></span>is_loading</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType , std::uint32_t Flags = 0&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::<a class="el" href="classcereal_1_1InputArchive.html#adeb555e9b25f21391e4cc9eca9f04dbd">is_loading</a> = std::true_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates this archive is intended for loading. </p>
<p>This ensures compatibility with boost archive types. If you are transitioning from boost, you can check this value within a member or external serialize function (i.e., Archive::is_loading::value) to enable behavior specific to loading, until you can transition to split save/load or save_minimal/load_minimal functions </p>
</div>
</div>
<a id="af90a8d1dc2c9163367765817f7b704d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af90a8d1dc2c9163367765817f7b704d4">&#9670;&nbsp;</a></span>is_saving</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType , std::uint32_t Flags = 0&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::<a class="el" href="classcereal_1_1InputArchive.html#af90a8d1dc2c9163367765817f7b704d4">is_saving</a> = std::false_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates this archive is not intended for saving. </p>
<p>This ensures compatibility with boost archive types. If you are transitioning from boost, you can check this value within a member or external serialize function (i.e., Archive::is_saving::value) to disable behavior specific to loading, until you can transition to split save/load or save_minimal/load_minimal functions </p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a76455fba49795d1676664f634918c580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76455fba49795d1676664f634918c580">&#9670;&nbsp;</a></span>InputArchive()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &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>derived</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">derived</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 id="a2d39247b893f26eecc863a7b321e6a00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d39247b893f26eecc863a7b321e6a00">&#9670;&nbsp;</a></span>getPolymorphicName()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &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>
</div>
</div>
<a id="a27251df805e938bd528dd680c2df5a47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27251df805e938bd528dd680c2df5a47">&#9670;&nbsp;</a></span>getSharedPointer()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &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>
</div>
</div>
<a id="a88c7141a24a934978b1ef9894215e67f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88c7141a24a934978b1ef9894215e67f">&#9670;&nbsp;</a></span>operator&amp;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType , std::uint32_t Flags = 0&gt; </div>
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ArchiveType&amp; <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::operator&amp; </td>
<td>(</td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>arg</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>Serializes passed in data. </p>
<p>This is a boost compatability layer and is not the preferred way of using cereal. If you are transitioning from boost, use this until you can transition to the operator() overload </p>
</div>
</div>
<a id="a21bf0587ab9749e2afde4bb51d8988ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21bf0587ab9749e2afde4bb51d8988ec">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType , std::uint32_t Flags = 0&gt; </div>
<div class="memtemplate">
template&lt;class ... Types&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ArchiveType&amp; <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Types &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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>Serializes all passed in data. </p>
<p>This is the primary interface for serializing data with an archive </p>
</div>
</div>
<a id="abe460125bb5603ae92517d21d2733491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe460125bb5603ae92517d21d2733491">&#9670;&nbsp;</a></span>operator&gt;&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ArchiveType , std::uint32_t Flags = 0&gt; </div>
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ArchiveType&amp; <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>arg</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>Serializes passed in data. </p>
<p>This is a boost compatability layer and is not the preferred way of using cereal. If you are transitioning from boost, use this until you can transition to the operator() overload </p>
</div>
</div>
<a id="ae6602c484b49376ad1c392719d02ef56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6602c484b49376ad1c392719d02ef56">&#9670;&nbsp;</a></span>registerPolymorphicName()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &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>
</div>
</div>
<a id="a5a8c43c2803faa0b78cfb42e10c91d93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a8c43c2803faa0b78cfb42e10c91d93">&#9670;&nbsp;</a></span>registerSharedPointer()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &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 allocated for the first time, it should be registered with its loaded id for future references to it. </p>
</div>
</div>
<a id="a846b9482bf620966e2fa91921251a307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a846b9482bf620966e2fa91921251a307">&#9670;&nbsp;</a></span>serializeDeferments()</h2>
<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, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::serializeDeferments </td>
<td>(</td>
<td class="paramname"></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>Serializes any data marked for deferment using defer. </p>
<p>This will cause any data wrapped in <a class="el" href="classcereal_1_1DeferredData.html" title="A wrapper around data that should be serialized after all non-deferred data.">DeferredData</a> to be immediately serialized </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 27 2022 19:46:46 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-42360142-1', 'uscilab.github.io');
ga('send', 'pageview');
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink