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_1OutputArchive.html
Shane Grant bf9fc8231e Update doc for 132
2022-02-27 19:48:38 -08:00

443 lines
27 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::OutputArchive&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_1OutputArchive.html">OutputArchive</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_1OutputArchive-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::OutputArchive&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 output archive class.
<a href="classcereal_1_1OutputArchive.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::OutputArchive&lt; ArchiveType, Flags &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classcereal_1_1OutputArchive.png" usemap="#cereal::OutputArchive_3C_20ArchiveType_2C_20Flags_20_3E_map" alt=""/>
<map id="cereal::OutputArchive_3C_20ArchiveType_2C_20Flags_20_3E_map" name="cereal::OutputArchive_3C_20ArchiveType_2C_20Flags_20_3E_map">
<area href="classcereal_1_1detail_1_1OutputArchiveBase.html" alt="cereal::detail::OutputArchiveBase" shape="rect" coords="0,0,273,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:a98fbde73bf6d41f4e717e91011e3be7f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a98fbde73bf6d41f4e717e91011e3be7f">OutputArchive</a> (ArchiveType *const derived)</td></tr>
<tr class="memdesc:a98fbde73bf6d41f4e717e91011e3be7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the output archive. <a href="classcereal_1_1OutputArchive.html#a98fbde73bf6d41f4e717e91011e3be7f">More...</a><br /></td></tr>
<tr class="separator:a98fbde73bf6d41f4e717e91011e3be7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c6421d26bc4d2cd95db038c3ce91a49"><td class="memItemLeft" align="right" valign="top"><a id="a2c6421d26bc4d2cd95db038c3ce91a49"></a>
<a class="el" href="classcereal_1_1OutputArchive.html">OutputArchive</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1OutputArchive.html">OutputArchive</a> const &amp;)=delete</td></tr>
<tr class="separator:a2c6421d26bc4d2cd95db038c3ce91a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abef67f45c79d199c690359715905987b"><td class="memTemplParams" colspan="2">template&lt;class ... Types&gt; </td></tr>
<tr class="memitem:abef67f45c79d199c690359715905987b"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#abef67f45c79d199c690359715905987b">operator()</a> (Types &amp;&amp;... args)</td></tr>
<tr class="memdesc:abef67f45c79d199c690359715905987b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all passed in data. <a href="classcereal_1_1OutputArchive.html#abef67f45c79d199c690359715905987b">More...</a><br /></td></tr>
<tr class="separator:abef67f45c79d199c690359715905987b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0070bbf21d6a02a48d55b8052b90f64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#ac0070bbf21d6a02a48d55b8052b90f64">serializeDeferments</a> ()</td></tr>
<tr class="memdesc:ac0070bbf21d6a02a48d55b8052b90f64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes any data marked for deferment using defer. <a href="classcereal_1_1OutputArchive.html#ac0070bbf21d6a02a48d55b8052b90f64">More...</a><br /></td></tr>
<tr class="separator:ac0070bbf21d6a02a48d55b8052b90f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0efb18ad82f46327f48449e84222328b"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a0efb18ad82f46327f48449e84222328b">registerSharedPointer</a> (const std::shared_ptr&lt; const void &gt; &amp;sharedPointer)</td></tr>
<tr class="memdesc:a0efb18ad82f46327f48449e84222328b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a shared pointer with the archive. <a href="classcereal_1_1OutputArchive.html#a0efb18ad82f46327f48449e84222328b">More...</a><br /></td></tr>
<tr class="separator:a0efb18ad82f46327f48449e84222328b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf97e7c48f6d307d6fa87d4b3fd3ad0e"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#abf97e7c48f6d307d6fa87d4b3fd3ad0e">registerPolymorphicType</a> (char const *name)</td></tr>
<tr class="memdesc:abf97e7c48f6d307d6fa87d4b3fd3ad0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a polymorphic type name with the archive. <a href="classcereal_1_1OutputArchive.html#abf97e7c48f6d307d6fa87d4b3fd3ad0e">More...</a><br /></td></tr>
<tr class="separator:abf97e7c48f6d307d6fa87d4b3fd3ad0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1detail_1_1OutputArchiveBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">cereal::detail::OutputArchiveBase</a></td></tr>
<tr class="memitem:a4cbe03d4e35e298aaab32eaf117021be inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a4cbe03d4e35e298aaab32eaf117021be"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>OutputArchiveBase</b> (<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:a4cbe03d4e35e298aaab32eaf117021be inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd5f88c3cc3ef044eea98df20b1f01db inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="afd5f88c3cc3ef044eea98df20b1f01db"></a>
<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> &amp;&amp;) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
<tr class="separator:afd5f88c3cc3ef044eea98df20b1f01db inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><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:a8f3be4fe8a965bbce4eb1cf36068e611"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a8f3be4fe8a965bbce4eb1cf36068e611">is_loading</a> = std::false_type</td></tr>
<tr class="memdesc:a8f3be4fe8a965bbce4eb1cf36068e611"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates this archive is not intended for loading. <a href="classcereal_1_1OutputArchive.html#a8f3be4fe8a965bbce4eb1cf36068e611">More...</a><br /></td></tr>
<tr class="separator:a8f3be4fe8a965bbce4eb1cf36068e611"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad48175118ea9b931ef42a74f8efd0389"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#ad48175118ea9b931ef42a74f8efd0389">is_saving</a> = std::true_type</td></tr>
<tr class="memdesc:ad48175118ea9b931ef42a74f8efd0389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates this archive is intended for saving. <a href="classcereal_1_1OutputArchive.html#ad48175118ea9b931ef42a74f8efd0389">More...</a><br /></td></tr>
<tr class="separator:ad48175118ea9b931ef42a74f8efd0389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4788dde3f0691f0dbbfc14fe6e2997cd"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a4788dde3f0691f0dbbfc14fe6e2997cd"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a4788dde3f0691f0dbbfc14fe6e2997cd">operator&amp;</a> (T &amp;&amp;arg)</td></tr>
<tr class="memdesc:a4788dde3f0691f0dbbfc14fe6e2997cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1OutputArchive.html#a4788dde3f0691f0dbbfc14fe6e2997cd">More...</a><br /></td></tr>
<tr class="separator:a4788dde3f0691f0dbbfc14fe6e2997cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0316f5791b140979aea2c915e4618236"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a0316f5791b140979aea2c915e4618236"><td class="memTemplItemLeft" align="right" valign="top">ArchiveType &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a0316f5791b140979aea2c915e4618236">operator&lt;&lt;</a> (T &amp;&amp;arg)</td></tr>
<tr class="memdesc:a0316f5791b140979aea2c915e4618236"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1OutputArchive.html#a0316f5791b140979aea2c915e4618236">More...</a><br /></td></tr>
<tr class="separator:a0316f5791b140979aea2c915e4618236"><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::OutputArchive&lt; ArchiveType, Flags &gt;</h3>
<p>The base output archive class. </p>
<p>This is the base output archive for all output 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_1OutputArchive.html" title="The base output archive class.">OutputArchive</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="a8f3be4fe8a965bbce4eb1cf36068e611"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f3be4fe8a965bbce4eb1cf36068e611">&#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_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::<a class="el" href="classcereal_1_1OutputArchive.html#a8f3be4fe8a965bbce4eb1cf36068e611">is_loading</a> = std::false_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates this archive is not 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 disable behavior specific to loading, until you can transition to split save/load or save_minimal/load_minimal functions </p>
</div>
</div>
<a id="ad48175118ea9b931ef42a74f8efd0389"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad48175118ea9b931ef42a74f8efd0389">&#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_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::<a class="el" href="classcereal_1_1OutputArchive.html#ad48175118ea9b931ef42a74f8efd0389">is_saving</a> = std::true_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates this archive is 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 enable 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="a98fbde73bf6d41f4e717e91011e3be7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98fbde73bf6d41f4e717e91011e3be7f">&#9670;&nbsp;</a></span>OutputArchive()</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_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::<a class="el" href="classcereal_1_1OutputArchive.html">OutputArchive</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="a4788dde3f0691f0dbbfc14fe6e2997cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4788dde3f0691f0dbbfc14fe6e2997cd">&#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_1OutputArchive.html">cereal::OutputArchive</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="abef67f45c79d199c690359715905987b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef67f45c79d199c690359715905987b">&#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_1OutputArchive.html">cereal::OutputArchive</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="a0316f5791b140979aea2c915e4618236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0316f5791b140979aea2c915e4618236">&#9670;&nbsp;</a></span>operator&lt;&lt;()</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_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::operator&lt;&lt; </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="abf97e7c48f6d307d6fa87d4b3fd3ad0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf97e7c48f6d307d6fa87d4b3fd3ad0e">&#9670;&nbsp;</a></span>registerPolymorphicType()</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::uint32_t <a class="el" href="classcereal_1_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::registerPolymorphicType </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>name</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>Registers a polymorphic type name with the archive. </p>
<p>This function is used to track polymorphic types to prevent unnecessary saves of identifying strings used by the polymorphic support functionality. </p>
</div>
</div>
<a id="a0efb18ad82f46327f48449e84222328b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0efb18ad82f46327f48449e84222328b">&#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">std::uint32_t <a class="el" href="classcereal_1_1OutputArchive.html">cereal::OutputArchive</a>&lt; ArchiveType, <a class="el" href="group__Internal.html#ga95185aa9f39e4ac382bb6631beb68a67">Flags</a> &gt;::registerSharedPointer </td>
<td>(</td>
<td class="paramtype">const std::shared_ptr&lt; const void &gt; &amp;&#160;</td>
<td class="paramname"><em>sharedPointer</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>Registers a shared pointer with the archive. </p>
<p>This function is used to track shared pointer targets to prevent unnecessary saves from taking place if multiple shared pointers point to the same data. </p>
</div>
</div>
<a id="ac0070bbf21d6a02a48d55b8052b90f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0070bbf21d6a02a48d55b8052b90f64">&#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_1OutputArchive.html">cereal::OutputArchive</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