345 lines
20 KiB
HTML
345 lines
20 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::NameValuePair< T > 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/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 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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_1NameValuePair.html">NameValuePair</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#related">Related Functions</a> |
|
|
<a href="classcereal_1_1NameValuePair-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::NameValuePair< T > 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 <<a class="el" href="helpers_8hpp_source.html">cereal/details/helpers.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for cereal::NameValuePair< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classcereal_1_1NameValuePair.png" usemap="#cereal::NameValuePair< T >_map" alt=""/>
|
|
<map id="cereal::NameValuePair< T >_map" name="cereal::NameValuePair< T >_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#ada17c8f6c9895a9d2d7fa7859e48537c">NameValuePair</a> (char const *n, T &&v)</td></tr>
|
|
<tr class="memdesc:ada17c8f6c9895a9d2d7fa7859e48537c"><td class="mdescLeft"> </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="#ada17c8f6c9895a9d2d7fa7859e48537c">More...</a><br/></td></tr>
|
|
<tr class="separator:ada17c8f6c9895a9d2d7fa7859e48537c"><td class="memSeparator" colspan="2"> </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:a4be7d36ddc389a2d30546c6c651efb4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4be7d36ddc389a2d30546c6c651efb4f"></a>
|
|
char const * </td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
|
|
<tr class="separator:a4be7d36ddc389a2d30546c6c651efb4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acea4778862f82043fa15c177f848a675"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acea4778862f82043fa15c177f848a675"></a>
|
|
Type </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
|
|
<tr class="separator:acea4778862f82043fa15c177f848a675"><td class="memSeparator" colspan="2"> </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:a5bfb9090edc7c741335fba284e462a49"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a5bfb9090edc7c741335fba284e462a49"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a5bfb9090edc7c741335fba284e462a49">make_nvp</a> (std::string const &name, T &&value)</td></tr>
|
|
<tr class="memdesc:a5bfb9090edc7c741335fba284e462a49"><td class="mdescLeft"> </td><td class="mdescRight">Creates a name value pair. <a href="#a5bfb9090edc7c741335fba284e462a49">More...</a><br/></td></tr>
|
|
<tr class="separator:a5bfb9090edc7c741335fba284e462a49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a4ae230f9f8c3d979df8daa95ef6cbcdc">make_nvp</a> (const char *name, T &&value)</td></tr>
|
|
<tr class="memdesc:a4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="mdescLeft"> </td><td class="mdescRight">Creates a name value pair. <a href="#a4ae230f9f8c3d979df8daa95ef6cbcdc">More...</a><br/></td></tr>
|
|
<tr class="separator:a4ae230f9f8c3d979df8daa95ef6cbcdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memTemplParams" colspan="2"><a class="anchor" id="a7b7b9b5e674a363fb8fd9baca2ca73ce"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if< std::is_same<br class="typebreak"/>
|
|
< Archive,::<a class="el" href="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a> ><br class="typebreak"/>
|
|
::value||std::is_same< Archive,::<a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a> ><br class="typebreak"/>
|
|
::value, T && >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a7b7b9b5e674a363fb8fd9baca2ca73ce">make_nvp</a> (const char *, T &&value)</td></tr>
|
|
<tr class="memdesc:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="mdescLeft"> </td><td class="mdescRight">A specialization of make_nvp<> that simply forwards the value for binary archives. <br/></td></tr>
|
|
<tr class="separator:a7b7b9b5e674a363fb8fd9baca2ca73ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4f76432ed952dbfdc7e7973fb0d16ac1"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if<!std::is_same<br class="typebreak"/>
|
|
< Archive,::<a class="el" href="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a> ><br class="typebreak"/>
|
|
::value &&!std::is_same<br class="typebreak"/>
|
|
< Archive,::<a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a> ><br class="typebreak"/>
|
|
::value, <a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>< T ><br class="typebreak"/>
|
|
>::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1NameValuePair.html#a4f76432ed952dbfdc7e7973fb0d16ac1">make_nvp</a> (const char *name, T &&value)</td></tr>
|
|
<tr class="memdesc:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="mdescLeft"> </td><td class="mdescRight">A specialization of make_nvp<> that actually creates an nvp for non-binary archives. <br/></td></tr>
|
|
<tr class="separator:a4f76432ed952dbfdc7e7973fb0d16ac1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<class T><br/>
|
|
class cereal::NameValuePair< T ></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><<span class="keyword">class</span> Archive></div>
|
|
<div class="line"> <span class="keywordtype">void</span> serialize(Archive & archive)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> archive( CEREAL_NVP(a),</div>
|
|
<div class="line"> CEREAL_NVP(b),</div>
|
|
<div class="line"> CEREAL_NVP(c),</div>
|
|
<div class="line"> CEREAL_NVP(d),</div>
|
|
<div class="line"> CEREAL_NVP(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><<span class="keyword">class</span> Archive></div>
|
|
<div class="line"> <span class="keywordtype">void</span> serialize(Archive & archive)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> archive( CEREAL_NVP(a),</div>
|
|
<div class="line"> CEREAL_NVP(b),</div>
|
|
<div class="line"> cereal::make_nvp(<span class="stringliteral">"var"</span>, my_embarrassing_variable_name) );</div>
|
|
<div class="line"> CEREAL_NVP(d),</div>
|
|
<div class="line"> CEREAL_NVP(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 needed 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><<span class="keyword">class</span> Archive></div>
|
|
<div class="line"> <span class="keywordtype">void</span> serialize(Archive & archive)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> archive( cereal::make_nvp<Archive>(a),</div>
|
|
<div class="line"> cereal::make_nvp<Archive>(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 & Destructor Documentation</h2>
|
|
<a class="anchor" id="ada17c8f6c9895a9d2d7fa7859e48537c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </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>< T >::<a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const * </td>
|
|
<td class="paramname"><em>n</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T && </td>
|
|
<td class="paramname"><em>v</em> </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. In either case, any constness will be stripped away </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a class="anchor" id="a5bfb9090edc7c741335fba284e462a49"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>< T > make_nvp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string const & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T && </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">related</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a name value pair. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4ae230f9f8c3d979df8daa95ef6cbcdc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>< T > make_nvp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T && </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">related</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a name value pair. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>include/cereal/details/<a class="el" href="helpers_8hpp_source.html">helpers.hpp</a></li>
|
|
<li>include/cereal/<a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jul 5 2013 20:54:20 for cereal by  <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>
|