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

197 lines
11 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::LoadAndAllocate&lt; T &gt; Struct 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="structcereal_1_1LoadAndAllocate.html">LoadAndAllocate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structcereal_1_1LoadAndAllocate-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::LoadAndAllocate&lt; T &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that allows cereal to load smart pointers to types that have no default constructor.
<a href="structcereal_1_1LoadAndAllocate.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="access_8hpp_source.html">cereal/access.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5f3967bfc27dca97ca5255a3b6e7fdab"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1LoadAndAllocate.html#a5f3967bfc27dca97ca5255a3b6e7fdab">load_and_allocate</a> (...)</td></tr>
<tr class="memdesc:a5f3967bfc27dca97ca5255a3b6e7fdab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by cereal if no default constructor exists to load and allocate data simultaneously. <a href="#a5f3967bfc27dca97ca5255a3b6e7fdab">More...</a><br/></td></tr>
<tr class="separator:a5f3967bfc27dca97ca5255a3b6e7fdab"><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/>
struct cereal::LoadAndAllocate&lt; T &gt;</h3>
<p>A class that allows cereal to load smart pointers to types that have no default constructor. </p>
<p>If your class does not have a default constructor, cereal will not be able to load any smart pointers to it unless you overload <a class="el" href="structcereal_1_1LoadAndAllocate.html" title="A class that allows cereal to load smart pointers to types that have no default constructor.">LoadAndAllocate</a> for your class, and provide an appropriate load_and_allocate method.</p>
<p>The specialization of <a class="el" href="structcereal_1_1LoadAndAllocate.html" title="A class that allows cereal to load smart pointers to types that have no default constructor.">LoadAndAllocate</a> must be placed within the cereal namespace:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyType</div>
<div class="line">{</div>
<div class="line"> MyType( <span class="keywordtype">int</span> x ); <span class="comment">// note: no default ctor</span></div>
<div class="line"> <span class="keywordtype">int</span> myX;</div>
<div class="line"></div>
<div class="line"> <span class="comment">// Define a serialize or save/load pair as you normally would</span></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> serialize( Archive &amp; ar )</div>
<div class="line"> {</div>
<div class="line"> ar( myX );</div>
<div class="line"> }</div>
<div class="line">};</div>
<div class="line"></div>
<div class="line"><span class="comment">// Provide a specialization for LoadAndAllocate for your type</span></div>
<div class="line"><span class="keyword">namespace </span>cereal</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">template</span> &lt;&gt; <span class="keyword">struct </span>LoadAndAllocate&lt;MyType&gt;</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// load_and_allocate will be passed the archive that you will be loading</span></div>
<div class="line"> <span class="comment">// from and should return a raw pointer to a dynamically allocated instance</span></div>
<div class="line"> <span class="comment">// of your type.</span></div>
<div class="line"> <span class="comment">//</span></div>
<div class="line"> <span class="comment">// This will be captured by a smart pointer of some type and you need not</span></div>
<div class="line"> <span class="comment">// worry about managing the memory</span></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> MyType * <a class="code" href="structcereal_1_1LoadAndAllocate.html#a5f3967bfc27dca97ca5255a3b6e7fdab" title="Called by cereal if no default constructor exists to load and allocate data simultaneously.">load_and_allocate</a>( Archive &amp; ar )</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordtype">int</span> x;</div>
<div class="line"> ar( x );</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">new</span> MyType( x );</div>
<div class="line"> }</div>
<div class="line"> };</div>
<div class="line">} <span class="comment">// end namespace cereal</span></div>
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to specialize for </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5f3967bfc27dca97ca5255a3b6e7fdab"></a>
<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">static void <a class="el" href="structcereal_1_1LoadAndAllocate.html">cereal::LoadAndAllocate</a>&lt; T &gt;::load_and_allocate </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by cereal if no default constructor exists to load and allocate data simultaneously. </p>
<p>Overloads of this should return a pointer to T and expect an archive as a parameter </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/cereal/<a class="el" href="access_8hpp_source.html">access.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 5 2013 20:54:19 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink