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

170 lines
12 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::MapItem&lt; Key, Value &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_1MapItem.html">MapItem</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structcereal_1_1MapItem-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::MapItem&lt; Key, Value &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A wrapper around a key and value for serializing data into maps.
<a href="structcereal_1_1MapItem.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="helpers_8hpp_source.html">cereal/details/helpers.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa9ca5f7dd68ae0b570ee4c61bc9c71dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9ca5f7dd68ae0b570ee4c61bc9c71dc"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>DecayKey</b> = typename std::decay&lt; Key &gt;::type</td></tr>
<tr class="separator:aa9ca5f7dd68ae0b570ee4c61bc9c71dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac208ee88004132165398b85839b19243"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac208ee88004132165398b85839b19243"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>KeyType</b> = typename std::conditional&lt; std::is_rvalue_reference&lt; Key &gt;::value, DecayKey, typename std::add_lvalue_reference&lt; DecayKey &gt;::type &gt;::type</td></tr>
<tr class="separator:ac208ee88004132165398b85839b19243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf4702afc109fd544dc65a9b3505c668"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf4702afc109fd544dc65a9b3505c668"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>DecayValue</b> = typename std::decay&lt; Value &gt;::type</td></tr>
<tr class="separator:acf4702afc109fd544dc65a9b3505c668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f573d2b2b1191e3558d8a7ba595036b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f573d2b2b1191e3558d8a7ba595036b"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>ValueType</b> = typename std::conditional&lt; std::is_rvalue_reference&lt; Value &gt;::value, DecayValue, typename std::add_lvalue_reference&lt; DecayValue &gt;::type &gt;::type</td></tr>
<tr class="separator:a2f573d2b2b1191e3558d8a7ba595036b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aee3d63b7cb1ab67edc60b2234e6f92db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee3d63b7cb1ab67edc60b2234e6f92db"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1MapItem.html#aee3d63b7cb1ab67edc60b2234e6f92db">MapItem</a> (Key &amp;&amp;key, Value &amp;&amp;value)</td></tr>
<tr class="memdesc:aee3d63b7cb1ab67edc60b2234e6f92db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="structcereal_1_1MapItem.html" title="A wrapper around a key and value for serializing data into maps.">MapItem</a> from a key and a value. <br/></td></tr>
<tr class="separator:aee3d63b7cb1ab67edc60b2234e6f92db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d09988754e8e86d8f40bee73421d329"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4d09988754e8e86d8f40bee73421d329"></a>
template&lt;class Archive &gt; </td></tr>
<tr class="memitem:a4d09988754e8e86d8f40bee73421d329"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structcereal_1_1MapItem.html#a4d09988754e8e86d8f40bee73421d329">serialize</a> (Archive &amp;archive)</td></tr>
<tr class="memdesc:a4d09988754e8e86d8f40bee73421d329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize the <a class="el" href="structcereal_1_1MapItem.html" title="A wrapper around a key and value for serializing data into maps.">MapItem</a> with the NVPs "key" and "value". <br/></td></tr>
<tr class="separator:a4d09988754e8e86d8f40bee73421d329"><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:af4d4e11ae4f201877bc57952becf2eef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4d4e11ae4f201877bc57952becf2eef"></a>
KeyType&#160;</td><td class="memItemRight" valign="bottom"><b>key</b></td></tr>
<tr class="separator:af4d4e11ae4f201877bc57952becf2eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afba0b9518e84a845eb2b6f1f74cf3f56"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afba0b9518e84a845eb2b6f1f74cf3f56"></a>
ValueType&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:afba0b9518e84a845eb2b6f1f74cf3f56"><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 Key, class Value&gt;<br/>
struct cereal::MapItem&lt; Key, Value &gt;</h3>
<p>A wrapper around a key and value for serializing data into maps. </p>
<p>This class just provides a grouping of keys and values into a struct for human readable archives. For example, XML archives will use this wrapper to write maps like so:</p>
<div class="fragment"><div class="line">&lt;mymap&gt;</div>
<div class="line"> &lt;item0&gt;</div>
<div class="line"> &lt;key&gt;MyFirstKey&lt;/key&gt;</div>
<div class="line"> &lt;value&gt;MyFirstValue&lt;/value&gt;</div>
<div class="line"> &lt;/item0&gt;</div>
<div class="line"> &lt;item1&gt;</div>
<div class="line"> &lt;key&gt;MySecondKey&lt;/key&gt;</div>
<div class="line"> &lt;value&gt;MySecondValue&lt;/value&gt;</div>
<div class="line"> &lt;/item1&gt;</div>
<div class="line">&lt;/mymap&gt;</div>
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd>make_map_item </dd></dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/cereal/details/<a class="el" href="helpers_8hpp_source.html">helpers.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 &#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