Files
cereal/assets/doxygen/classcereal_1_1access.html
T
2013-07-05 20:56:22 -07:00

156 lines
11 KiB
HTML

<!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::access Class 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_1access.html">access</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="classcereal_1_1access-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::access Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that can be made a friend to give cereal access to non public functions.
<a href="classcereal_1_1access.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:a5802cef18afaebd4575bba992100aa34"><td class="memTemplParams" colspan="2"><a class="anchor" id="a5802cef18afaebd4575bba992100aa34"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a5802cef18afaebd4575bba992100aa34"><td class="memTemplItemLeft" align="right" valign="top">static auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>member_serialize</b> (Archive &amp;ar, T &amp;t) -&gt; decltype(t.serialize(ar))</td></tr>
<tr class="separator:a5802cef18afaebd4575bba992100aa34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e4738ac69abc3aa64c47aa327e4f767"><td class="memTemplParams" colspan="2"><a class="anchor" id="a1e4738ac69abc3aa64c47aa327e4f767"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a1e4738ac69abc3aa64c47aa327e4f767"><td class="memTemplItemLeft" align="right" valign="top">static auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>member_save</b> (Archive &amp;ar, T const &amp;t) -&gt; decltype(t.save(ar))</td></tr>
<tr class="separator:a1e4738ac69abc3aa64c47aa327e4f767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a025da815d782fd06f8199bec852f7f10"><td class="memTemplParams" colspan="2"><a class="anchor" id="a025da815d782fd06f8199bec852f7f10"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a025da815d782fd06f8199bec852f7f10"><td class="memTemplItemLeft" align="right" valign="top">static auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>non_const_member_save</b> (Archive &amp;ar, T &amp;t) -&gt; decltype(t.save(ar))</td></tr>
<tr class="separator:a025da815d782fd06f8199bec852f7f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a691dd84305c94c69f9eea0a79258b0ee"><td class="memTemplParams" colspan="2"><a class="anchor" id="a691dd84305c94c69f9eea0a79258b0ee"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a691dd84305c94c69f9eea0a79258b0ee"><td class="memTemplItemLeft" align="right" valign="top">static auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>member_load</b> (Archive &amp;ar, T &amp;t) -&gt; decltype(t.load(ar))</td></tr>
<tr class="separator:a691dd84305c94c69f9eea0a79258b0ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6346d0f2eafdd2bf9b6e57c1beb8d2d"><td class="memTemplParams" colspan="2"><a class="anchor" id="ad6346d0f2eafdd2bf9b6e57c1beb8d2d"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:ad6346d0f2eafdd2bf9b6e57c1beb8d2d"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>load_and_allocate</b> (...)</td></tr>
<tr class="separator:ad6346d0f2eafdd2bf9b6e57c1beb8d2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7b5bb977227021aed5452e8133c83ed"><td class="memTemplParams" colspan="2"><a class="anchor" id="ad7b5bb977227021aed5452e8133c83ed"></a>
template&lt;class T , class Archive &gt; </td></tr>
<tr class="memitem:ad7b5bb977227021aed5452e8133c83ed"><td class="memTemplItemLeft" align="right" valign="top">static auto&#160;</td><td class="memTemplItemRight" valign="bottom"><b>load_and_allocate</b> (Archive &amp;ar) -&gt; decltype(T::load_and_allocate(ar))</td></tr>
<tr class="separator:ad7b5bb977227021aed5452e8133c83ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that can be made a friend to give cereal access to non public functions. </p>
<p>If you desire non-public serialization functions within a class, cereal can only access these if you declare <a class="el" href="classcereal_1_1access.html" title="A class that can be made a friend to give cereal access to non public functions.">cereal::access</a> a friend.</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>MyClass</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">private</span>:</div>
<div class="line"> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classcereal_1_1access.html" title="A class that can be made a friend to give cereal access to non public functions.">cereal::access</a>; <span class="comment">// gives access to the private serialize</span></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> serialize( Archive &amp; ar )</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// some code</span></div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --> </div><hr/>The documentation for this class 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>