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

291 lines
16 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::construct&lt; T &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_1construct.html">construct</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_1construct-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::construct&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used to construct types with no default constructor.
<a href="classcereal_1_1construct.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="access_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/access.hpp</a>&gt;</code></p>
<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:aaba035d9e4f28e789055ee05f4de83e9"><td class="memTemplParams" colspan="2">template&lt;class ... Args&gt; </td></tr>
<tr class="memitem:aaba035d9e4f28e789055ee05f4de83e9"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1construct.html#aaba035d9e4f28e789055ee05f4de83e9">operator()</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:aaba035d9e4f28e789055ee05f4de83e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct and initialize the type T with the given arguments. <a href="classcereal_1_1construct.html#aaba035d9e4f28e789055ee05f4de83e9">More...</a><br /></td></tr>
<tr class="separator:aaba035d9e4f28e789055ee05f4de83e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec51948b204f0b5f6b1cd60dd0a39234"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1construct.html#aec51948b204f0b5f6b1cd60dd0a39234">operator-&gt;</a> ()</td></tr>
<tr class="memdesc:aec51948b204f0b5f6b1cd60dd0a39234"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a reference to the initialized underlying object. <a href="classcereal_1_1construct.html#aec51948b204f0b5f6b1cd60dd0a39234">More...</a><br /></td></tr>
<tr class="separator:aec51948b204f0b5f6b1cd60dd0a39234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bfac9c7b8fa2e8cd61fe39d2dd6148d"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1construct.html#a3bfac9c7b8fa2e8cd61fe39d2dd6148d">ptr</a> ()</td></tr>
<tr class="memdesc:a3bfac9c7b8fa2e8cd61fe39d2dd6148d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a raw pointer to the initialized underlying object. <a href="classcereal_1_1construct.html#a3bfac9c7b8fa2e8cd61fe39d2dd6148d">More...</a><br /></td></tr>
<tr class="separator:a3bfac9c7b8fa2e8cd61fe39d2dd6148d"><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:a78310d6c4c678dd6afacbccc3feaf174"><td class="memTemplParams" colspan="2"><a id="a78310d6c4c678dd6afacbccc3feaf174"></a>
template&lt;class Ar , class TT &gt; </td></tr>
<tr class="memitem:a78310d6c4c678dd6afacbccc3feaf174"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><b>::cereal::memory_detail::LoadAndConstructLoadWrapper</b></td></tr>
<tr class="separator:a78310d6c4c678dd6afacbccc3feaf174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b518d294ce424a7304cd0a3d517ae48"><td class="memTemplParams" colspan="2"><a id="a8b518d294ce424a7304cd0a3d517ae48"></a>
template&lt;class Ar , class TT &gt; </td></tr>
<tr class="memitem:a8b518d294ce424a7304cd0a3d517ae48"><td class="memTemplItemLeft" align="right" valign="top">struct&#160;</td><td class="memTemplItemRight" valign="bottom"><b>::cereal::boost_variant_detail::LoadAndConstructLoadWrapper</b></td></tr>
<tr class="separator:a8b518d294ce424a7304cd0a3d517ae48"><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 T&gt;<br />
class cereal::construct&lt; T &gt;</h3>
<p>Used to construct types with no default constructor. </p>
<p>When serializing a type that has no default constructor, cereal will attempt to call either the class static function load_and_construct or the appropriate template specialization of <a class="el" href="structcereal_1_1LoadAndConstruct.html" title="A class that allows cereal to load smart pointers to types that have no default constructor.">LoadAndConstruct</a>. cereal will pass that function a reference to the archive as well as a reference to a construct object which should be used to perform the allocation once data has been appropriately loaded.</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyType</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// note the lack of default constructor</span></div>
<div class="line"> MyType( <span class="keywordtype">int</span> xx, <span class="keywordtype">int</span> yy );</div>
<div class="line"> </div>
<div class="line"> <span class="keywordtype">int</span> x, y;</div>
<div class="line"> <span class="keywordtype">double</span> notInConstructor;</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> Archive&gt;</div>
<div class="line"> <span class="keywordtype">void</span> <a class="code" href="functional_8hpp.html#a02f9cfc9a4055c8a49eb050b02cd3357">serialize</a>( Archive &amp; ar )</div>
<div class="line"> {</div>
<div class="line"> ar( x, y );</div>
<div class="line"> ar( notInConstructor );</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">class</span> Archive&gt;</div>
<div class="line"> <span class="keyword">static</span> <span class="keywordtype">void</span> load_and_construct( Archive &amp; ar, <a class="code" href="classcereal_1_1construct.html">cereal::construct&lt;MyType&gt;</a> &amp; construct )</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordtype">int</span> x, y;</div>
<div class="line"> ar( x, y );</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// use construct object to initialize with loaded data</span></div>
<div class="line"> construct( x, y );</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// access to member variables and functions via -&gt; operator</span></div>
<div class="line"> ar( construct-&gt;notInConstructor );</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// could also do the above section by:</span></div>
<div class="line"> <span class="keywordtype">double</span> z;</div>
<div class="line"> ar( z );</div>
<div class="line"> construct-&gt;notInConstructor = z;</div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The class type being serialized </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aaba035d9e4f28e789055ee05f4de83e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaba035d9e4f28e789055ee05f4de83e9">&#9670;&nbsp;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<div class="memtemplate">
template&lt;class ... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcereal_1_1construct.html">cereal::construct</a>&lt; T &gt;::operator() </td>
<td>(</td>
<td class="paramtype">Args &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>Construct and initialize the type T with the given arguments. </p>
<p>This will forward all arguments to the underlying type T, calling an appropriate constructor.</p>
<p>Calling this function more than once will result in an exception being thrown.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>The arguments to the constructor for T </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="structcereal_1_1Exception.html" title="An exception class thrown when things go wrong at runtime.">Exception</a></td><td>If called more than once </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aec51948b204f0b5f6b1cd60dd0a39234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec51948b204f0b5f6b1cd60dd0a39234">&#9670;&nbsp;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classcereal_1_1construct.html">cereal::construct</a>&lt; T &gt;::operator-&gt; </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>Get a reference to the initialized underlying object. </p>
<p>This must be called after the object has been initialized.</p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the initialized object </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="structcereal_1_1Exception.html" title="An exception class thrown when things go wrong at runtime.">Exception</a></td><td>If called before initialization </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3bfac9c7b8fa2e8cd61fe39d2dd6148d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bfac9c7b8fa2e8cd61fe39d2dd6148d">&#9670;&nbsp;</a></span>ptr()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classcereal_1_1construct.html">cereal::construct</a>&lt; T &gt;::ptr </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>Returns a raw pointer to the initialized underlying object. </p>
<p>This is mainly intended for use with passing an instance of a constructed object to <a class="el" href="structcereal_1_1base__class.html" title="Casts a derived class to its non-virtual base class in a way that safely supports abstract classes.">cereal::base_class</a>.</p>
<p>It is strongly recommended to avoid using this function in any other circumstance.</p>
<dl class="section return"><dt>Returns</dt><dd>A raw pointer to the initialized type </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="access_8hpp_source.html">access.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclasscereal_1_1construct_html"><div class="ttname"><a href="classcereal_1_1construct.html">cereal::construct</a></div><div class="ttdoc">Used to construct types with no default constructor.</div><div class="ttdef"><b>Definition:</b> access.hpp:164</div></div>
<div class="ttc" id="afunctional_8hpp_html_a02f9cfc9a4055c8a49eb050b02cd3357"><div class="ttname"><a href="functional_8hpp.html#a02f9cfc9a4055c8a49eb050b02cd3357">cereal::serialize</a></div><div class="ttdeci">void serialize(Archive &amp;, std::less&lt; T &gt; &amp;)</div><div class="ttdoc">Saving for std::less.</div><div class="ttdef"><b>Definition:</b> functional.hpp:39</div></div>
<!-- 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