1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class packed_iarchive</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../mpi/reference.html#header.boost.mpi.packed_iarchive_hpp" title="Header <boost/mpi/packed_iarchive.hpp>"> 10<link rel="prev" href="minimum.html" title="Struct template minimum"> 11<link rel="next" href="packed_oarchive.html" title="Class packed_oarchive"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="minimum.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.packed_iarchive_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="packed_oarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.mpi.packed_iarchive"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class packed_iarchive</span></h2> 30<p>boost::mpi::packed_iarchive — An archive that unpacks binary data from an MPI buffer. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../mpi/reference.html#header.boost.mpi.packed_iarchive_hpp" title="Header <boost/mpi/packed_iarchive.hpp>">boost/mpi/packed_iarchive.hpp</a>> 34 35</span> 36<span class="keyword">class</span> <a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">iprimitive</span> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="packed_iarchive.html#boost.mpi.packed_iarchiveconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_5-bb"><span class="identifier">packed_iarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span><span class="special">,</span> 40 <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 41 <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_6-bb"><span class="identifier">packed_iarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 42 <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4-bb">public member functions</a></span> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_1-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_2-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_3-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 48 <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_4-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 49 <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_5-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 50 <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_6-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">version_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 51 <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_7-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_reference_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 52 <span class="keyword">void</span> <a class="link" href="packed_iarchive.html#id-1_3_27_7_18_2_1_1_4_8-bb"><span class="identifier">load_override</span></a><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 53<span class="special">}</span><span class="special">;</span></pre></div> 54<div class="refsect1"> 55<a name="id-1.3.27.7.19.4.4"></a><h2>Description</h2> 56<p>The <code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code> class is an Archiver (as in the Boost.Serialization library) that unpacks binary data from a buffer received via MPI. It can operate on any Serializable data type and will use the <code class="computeroutput">MPI_Unpack</code> function of the underlying MPI implementation to perform deserialization. </p> 57<div class="refsect2"> 58<a name="id-1.3.27.7.19.4.4.3"></a><h3> 59<a name="boost.mpi.packed_iarchiveconstruct-copy-destruct"></a><code class="computeroutput">packed_iarchive</code> 60 public 61 construct/copy/destruct</h3> 62<div class="orderedlist"><ol class="orderedlist" type="1"> 63<li class="listitem"> 64<pre class="literallayout"><a name="id-1_3_27_7_18_2_1_1_5-bb"></a><span class="identifier">packed_iarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">buffer_type</span> <span class="special">&</span> b<span class="special">,</span> 65 <span class="keyword">unsigned</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">,</span> 66 <span class="keyword">int</span> position <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> 67<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code></code> to receive data over the given MPI communicator and with an initial buffer.</p> 68<p> 69</p> 70<div class="variablelist"><table border="0" class="variablelist compact"> 71<colgroup> 72<col align="left" valign="top"> 73<col> 74</colgroup> 75<tbody><tr> 76<td><p><span class="term">Parameters:</span></p></td> 77<td><div class="variablelist"><table border="0" class="variablelist compact"> 78<colgroup> 79<col align="left" valign="top"> 80<col> 81</colgroup> 82<tbody> 83<tr> 84<td><p><span class="term"><code class="computeroutput">b</code></span></p></td> 85<td><p>A user-defined buffer that contains the binary representation of serialized objects.</p></td> 86</tr> 87<tr> 88<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> 89<td><p>The communicator over which this archive will be received.</p></td> 90</tr> 91<tr> 92<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> 93<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags. </p></td> 94</tr> 95</tbody> 96</table></div></td> 97</tr></tbody> 98</table></div> 99</li> 100<li class="listitem"> 101<pre class="literallayout"><a name="id-1_3_27_7_18_2_1_1_6-bb"></a><span class="identifier">packed_iarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&</span> comm<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> s <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 102 <span class="keyword">unsigned</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">no_header</span><span class="special">)</span><span class="special">;</span></pre> 103<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code></code> to receive data over the given MPI communicator.</p> 104<p> 105</p> 106<div class="variablelist"><table border="0" class="variablelist compact"> 107<colgroup> 108<col align="left" valign="top"> 109<col> 110</colgroup> 111<tbody><tr> 112<td><p><span class="term">Parameters:</span></p></td> 113<td><div class="variablelist"><table border="0" class="variablelist compact"> 114<colgroup> 115<col align="left" valign="top"> 116<col> 117</colgroup> 118<tbody> 119<tr> 120<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> 121<td><p>The communicator over which this archive will be received.</p></td> 122</tr> 123<tr> 124<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> 125<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags. </p></td> 126</tr> 127</tbody> 128</table></div></td> 129</tr></tbody> 130</table></div> 131</li> 132</ol></div> 133</div> 134<div class="refsect2"> 135<a name="id-1.3.27.7.19.4.4.4"></a><h3> 136<a name="id-1_3_27_7_18_2_1_1_4-bb"></a><code class="computeroutput">packed_iarchive</code> public member functions</h3> 137<div class="orderedlist"><ol class="orderedlist" type="1"> 138<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_1-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span> x<span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span><span class="special">)</span><span class="special">;</span></pre></li> 139<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_2-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span> x<span class="special">,</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span><span class="special">)</span><span class="special">;</span></pre></li> 140<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_3-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&</span> x<span class="special">)</span><span class="special">;</span></pre></li> 141<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_4-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_optional_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> 142<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_5-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_type</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 143<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_6-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">version_type</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 144<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_7-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_id_reference_type</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 145<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_18_2_1_1_4_8-bb"></a><span class="identifier">load_override</span><span class="special">(</span><span class="identifier">archive</span><span class="special">::</span><span class="identifier">class_name_type</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre></li> 146</ol></div> 147</div> 148</div> 149</div> 150<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 151<td align="left"></td> 152<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, 153 Matthias Troyer, Trustees of Indiana University<p> 154 Distributed under the Boost Software License, Version 1.0. (See accompanying 155 file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> 156 http://www.boost.org/LICENSE_1_0.txt </ulink>) 157 </p> 158</div></td> 159</tr></table> 160<hr> 161<div class="spirit-nav"> 162<a accesskey="p" href="minimum.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.packed_iarchive_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="packed_oarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 163</div> 164</body> 165</html> 166
