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

252 lines
18 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::NameValuePair&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_1NameValuePair.html">NameValuePair</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classcereal_1_1NameValuePair-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::NameValuePair&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>For holding name value pairs.
<a href="classcereal_1_1NameValuePair.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="helpers_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/details/helpers.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cereal::NameValuePair&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classcereal_1_1NameValuePair.png" usemap="#cereal::NameValuePair_3C_20T_20_3E_map" alt=""/>
<map id="cereal::NameValuePair_3C_20T_20_3E_map" name="cereal::NameValuePair_3C_20T_20_3E_map">
<area href="structcereal_1_1detail_1_1NameValuePairCore.html" alt="cereal::detail::NameValuePairCore" shape="rect" coords="0,0,206,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:ada17c8f6c9895a9d2d7fa7859e48537c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#ada17c8f6c9895a9d2d7fa7859e48537c">NameValuePair</a> (char const *n, T &amp;&amp;v)</td></tr>
<tr class="memdesc:ada17c8f6c9895a9d2d7fa7859e48537c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classcereal_1_1NameValuePair.html" title="For holding name value pairs.">NameValuePair</a>. <a href="classcereal_1_1NameValuePair.html#ada17c8f6c9895a9d2d7fa7859e48537c">More...</a><br /></td></tr>
<tr class="separator:ada17c8f6c9895a9d2d7fa7859e48537c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a984068df7dec87c0d2d32ce16b949f25"><td class="memItemLeft" align="right" valign="top"><a id="a984068df7dec87c0d2d32ce16b949f25"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
<tr class="separator:a984068df7dec87c0d2d32ce16b949f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acea4778862f82043fa15c177f848a675"><td class="memItemLeft" align="right" valign="top"><a id="acea4778862f82043fa15c177f848a675"></a>
Type&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:acea4778862f82043fa15c177f848a675"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:ga5bfb9090edc7c741335fba284e462a49"><td class="memTemplParams" colspan="2">
template&lt;class T &gt; </td></tr>
<tr class="memitem:ga5bfb9090edc7c741335fba284e462a49"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Utility.html#ga5bfb9090edc7c741335fba284e462a49">make_nvp</a> (std::string const &amp;name, T &amp;&amp;value)</td></tr>
<tr class="memdesc:ga5bfb9090edc7c741335fba284e462a49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a name value pair. <br /></td></tr>
<tr class="separator:ga5bfb9090edc7c741335fba284e462a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memTemplParams" colspan="2">
template&lt;class T &gt; </td></tr>
<tr class="memitem:ga4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Utility.html#ga4ae230f9f8c3d979df8daa95ef6cbcdc">make_nvp</a> (const char *name, T &amp;&amp;value)</td></tr>
<tr class="memdesc:ga4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a name value pair. <br /></td></tr>
<tr class="separator:ga4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memTemplParams" colspan="2"><a id="a7b7b9b5e674a363fb8fd9baca2ca73ce"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt; std::is_same&lt; Archive,::<a class="el" href="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a> &gt;::value||std::is_same&lt; Archive,::<a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a> &gt;::value, T &amp;&amp; &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a7b7b9b5e674a363fb8fd9baca2ca73ce">make_nvp</a> (const char *, T &amp;&amp;value)</td></tr>
<tr class="memdesc:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specialization of make_nvp&lt;&gt; that simply forwards the value for binary archives. <br /></td></tr>
<tr class="separator:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="memTemplParams" colspan="2"><a id="a4f76432ed952dbfdc7e7973fb0d16ac1"></a>
template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt;!std::is_same&lt; Archive,::<a class="el" href="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a> &gt;::value &amp;&amp;!std::is_same&lt; Archive,::<a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a> &gt;::value, <a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>&lt; T &gt; &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a4f76432ed952dbfdc7e7973fb0d16ac1">make_nvp</a> (const char *name, T &amp;&amp;value)</td></tr>
<tr class="memdesc:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specialization of make_nvp&lt;&gt; that actually creates an nvp for non-binary archives. <br /></td></tr>
<tr class="separator:a4f76432ed952dbfdc7e7973fb0d16ac1"><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::NameValuePair&lt; T &gt;</h3>
<p>For holding name value pairs. </p>
<p>This pairs a name (some string) with some value such that an archive can potentially take advantage of the pairing.</p>
<p>In serialization functions, NameValuePairs are usually created like so: </p><div class="fragment"><div class="line"><span class="keyword">struct </span>MyStruct</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">int</span> a, b, c, d, e;</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; archive)</div>
<div class="line"> {</div>
<div class="line"> archive( <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(a),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(b),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(c),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(d),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(e) );</div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --><p>Alternatively, you can give you data members custom names like so: </p><div class="fragment"><div class="line"><span class="keyword">struct </span>MyStruct</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">int</span> a, b, my_embarrassing_variable_name, d, e;</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; archive)</div>
<div class="line"> {</div>
<div class="line"> archive( <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(a),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(b),</div>
<div class="line"> cereal::make_nvp(<span class="stringliteral">&quot;var&quot;</span>, my_embarrassing_variable_name) );</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(d),</div>
<div class="line"> <a class="code" href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a>(e) );</div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --><p>There is a slight amount of overhead to creating NameValuePairs, so there is a third method which will elide the names when they are not used by the Archive:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyStruct</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">int</span> a, b;</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; archive)</div>
<div class="line"> {</div>
<div class="line"> archive( cereal::make_nvp&lt;Archive&gt;(a),</div>
<div class="line"> cereal::make_nvp&lt;Archive&gt;(b) );</div>
<div class="line"> }</div>
<div class="line">};</div>
</div><!-- fragment --><p>This third method is generally only used when providing generic type support. Users writing their own serialize functions will normally explicitly control whether they want to use NVPs or not. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ada17c8f6c9895a9d2d7fa7859e48537c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada17c8f6c9895a9d2d7fa7859e48537c">&#9670;&nbsp;</a></span>NameValuePair()</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"><a class="el" href="classcereal_1_1NameValuePair.html">cereal::NameValuePair</a>&lt; T &gt;::<a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a> </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>v</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>Constructs a new <a class="el" href="classcereal_1_1NameValuePair.html" title="For holding name value pairs.">NameValuePair</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The name of the pair </td></tr>
<tr><td class="paramname">v</td><td>The value to pair. Ideally this should be an l-value reference so that the value can be both loaded and saved to. If you pass an r-value reference, the <a class="el" href="classcereal_1_1NameValuePair.html" title="For holding name value pairs.">NameValuePair</a> will store a copy of it instead of a reference. Thus you should only pass r-values in cases where this makes sense, such as the result of some size() call. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="helpers_8hpp_source.html">helpers.hpp</a></li>
<li><a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="agroup__Utility_html_ga78892c2ccfac7a5454639ca121e84439"><div class="ttname"><a href="group__Utility.html#ga78892c2ccfac7a5454639ca121e84439">CEREAL_NVP</a></div><div class="ttdeci">#define CEREAL_NVP(T)</div><div class="ttdoc">Creates a name value pair for the variable T with the same name as the variable.</div><div class="ttdef"><b>Definition:</b> cereal.hpp:72</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