158 lines
14 KiB
HTML
158 lines
14 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::BinaryInputArchive 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 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_1BinaryInputArchive.html">BinaryInputArchive</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcereal_1_1BinaryInputArchive-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::BinaryInputArchive Class Reference<div class="ingroups"><a class="el" href="group__Archives.html">Input and output archive types</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An input archive designed to load data saved using <a class="el" href="classcereal_1_1BinaryOutputArchive.html" title="An output archive designed to save data in a compact binary representation.">BinaryOutputArchive</a>.
|
|
<a href="classcereal_1_1BinaryInputArchive.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="binary_8hpp_source.html">cereal/archives/binary.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for cereal::BinaryInputArchive:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classcereal_1_1BinaryInputArchive.png" usemap="#cereal::BinaryInputArchive_map" alt=""/>
|
|
<map id="cereal::BinaryInputArchive_map" name="cereal::BinaryInputArchive_map">
|
|
<area href="classcereal_1_1InputArchive.html" alt="cereal::InputArchive< BinaryInputArchive, AllowEmptyClassElision >" shape="rect" coords="0,56,401,80"/>
|
|
<area href="structcereal_1_1detail_1_1InputArchiveBase.html" alt="cereal::detail::InputArchiveBase" shape="rect" coords="0,0,401,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:a23eb5ff0ac7163632a2218361fe57c16"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23eb5ff0ac7163632a2218361fe57c16"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryInputArchive.html#a23eb5ff0ac7163632a2218361fe57c16">BinaryInputArchive</a> (std::istream &stream)</td></tr>
|
|
<tr class="memdesc:a23eb5ff0ac7163632a2218361fe57c16"><td class="mdescLeft"> </td><td class="mdescRight">Construct, loading from the provided stream. <br/></td></tr>
|
|
<tr class="separator:a23eb5ff0ac7163632a2218361fe57c16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb2268bb7d7ea6ae8699fb546937e89a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb2268bb7d7ea6ae8699fb546937e89a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryInputArchive.html#afb2268bb7d7ea6ae8699fb546937e89a">loadBinary</a> (void *const data, size_t size)</td></tr>
|
|
<tr class="memdesc:afb2268bb7d7ea6ae8699fb546937e89a"><td class="mdescLeft"> </td><td class="mdescRight">Reads size bytes of data from the input stream. <br/></td></tr>
|
|
<tr class="separator:afb2268bb7d7ea6ae8699fb546937e89a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classcereal_1_1InputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1InputArchive')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive< BinaryInputArchive, AllowEmptyClassElision ></a></td></tr>
|
|
<tr class="memitem:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a32c533e57346373d3600e02d1e47fdbf">InputArchive</a> (<a class="el" href="classcereal_1_1BinaryInputArchive.html">BinaryInputArchive</a> *const self)</td></tr>
|
|
<tr class="memdesc:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Construct the output archive. <a href="#a32c533e57346373d3600e02d1e47fdbf">More...</a><br/></td></tr>
|
|
<tr class="separator:a32c533e57346373d3600e02d1e47fdbf inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a248a3bc0b5d34877a267ab6e23241cf6"></a>
|
|
<a class="el" href="classcereal_1_1BinaryInputArchive.html">BinaryInputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a248a3bc0b5d34877a267ab6e23241cf6">operator()</a> (Types &&...args)</td></tr>
|
|
<tr class="memdesc:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes all passed in data. <br/></td></tr>
|
|
<tr class="separator:a248a3bc0b5d34877a267ab6e23241cf6 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a27251df805e938bd528dd680c2df5a47">getSharedPointer</a> (std::uint32_t const id)</td></tr>
|
|
<tr class="memdesc:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a shared pointer given a unique key for it. <a href="#a27251df805e938bd528dd680c2df5a47">More...</a><br/></td></tr>
|
|
<tr class="separator:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a5a8c43c2803faa0b78cfb42e10c91d93">registerSharedPointer</a> (std::uint32_t const id, std::shared_ptr< void > ptr)</td></tr>
|
|
<tr class="memdesc:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a shared pointer to its unique identifier. <a href="#a5a8c43c2803faa0b78cfb42e10c91d93">More...</a><br/></td></tr>
|
|
<tr class="separator:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a2d39247b893f26eecc863a7b321e6a00">getPolymorphicName</a> (std::uint32_t const id)</td></tr>
|
|
<tr class="memdesc:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the string for a polymorphic type given a unique key for it. <a href="#a2d39247b893f26eecc863a7b321e6a00">More...</a><br/></td></tr>
|
|
<tr class="separator:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#ae6602c484b49376ad1c392719d02ef56">registerPolymorphicName</a> (std::uint32_t const id, std::string const &name)</td></tr>
|
|
<tr class="memdesc:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a polymorphic name string to its unique identifier. <a href="#ae6602c484b49376ad1c392719d02ef56">More...</a><br/></td></tr>
|
|
<tr class="separator:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An input archive designed to load data saved using <a class="el" href="classcereal_1_1BinaryOutputArchive.html" title="An output archive designed to save data in a compact binary representation.">BinaryOutputArchive</a>. </p>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/cereal/archives/<a class="el" href="binary_8hpp_source.html">binary.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  <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>
|