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_oarchive</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_oarchive_hpp" title="Header <boost/mpi/packed_oarchive.hpp>"> 10<link rel="prev" href="packed_iarchive.html" title="Class packed_iarchive"> 11<link rel="next" href="python/register_serialized.html" title="Function template register_serialized"> 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="packed_iarchive.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.packed_oarchive_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="python/register_serialized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.mpi.packed_oarchive"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class packed_oarchive</span></h2> 30<p>boost::mpi::packed_oarchive — An archive that packs binary data into 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_oarchive_hpp" title="Header <boost/mpi/packed_oarchive.hpp>">boost/mpi/packed_oarchive.hpp</a>> 34 35</span> 36<span class="keyword">class</span> <a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">oprimitive</span> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="packed_oarchive.html#boost.mpi.packed_oarchiveconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_5-bb"><span class="identifier">packed_oarchive</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="special">;</span> 41 <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_6-bb"><span class="identifier">packed_oarchive</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="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> 42 43 <span class="comment">// <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_4-bb">public member functions</a></span> 44 <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_oarchive.html#id-1_3_27_7_19_2_1_1_4_1-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</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> 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_oarchive.html#id-1_3_27_7_19_2_1_1_4_2-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</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> 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_oarchive.html#id-1_3_27_7_19_2_1_1_4_3-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_4_4-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</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> 48 <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_4_5-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</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> 49 <span class="keyword">void</span> <a class="link" href="packed_oarchive.html#id-1_3_27_7_19_2_1_1_4_6-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</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_oarchive.html#id-1_3_27_7_19_2_1_1_4_7-bb"><span class="identifier">save_override</span></a><span class="special">(</span><span class="keyword">const</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="special">}</span><span class="special">;</span></pre></div> 52<div class="refsect1"> 53<a name="id-1.3.27.7.20.4.4"></a><h2>Description</h2> 54<p>The <code class="computeroutput"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a></code> class is an Archiver (as in the Boost.Serialization library) that packs binary data into a buffer for transmission via MPI. It can operate on any Serializable data type and will use the <code class="computeroutput">MPI_Pack</code> function of the underlying MPI implementation to perform serialization. </p> 55<div class="refsect2"> 56<a name="id-1.3.27.7.20.4.4.3"></a><h3> 57<a name="boost.mpi.packed_oarchiveconstruct-copy-destruct"></a><code class="computeroutput">packed_oarchive</code> 58 public 59 construct/copy/destruct</h3> 60<div class="orderedlist"><ol class="orderedlist" type="1"> 61<li class="listitem"> 62<pre class="literallayout"><a name="id-1_3_27_7_19_2_1_1_5-bb"></a><span class="identifier">packed_oarchive</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> 63 <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> 64<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> for transmission over the given MPI communicator and with an initial buffer.</p> 65<p> 66</p> 67<div class="variablelist"><table border="0" class="variablelist compact"> 68<colgroup> 69<col align="left" valign="top"> 70<col> 71</colgroup> 72<tbody><tr> 73<td><p><span class="term">Parameters:</span></p></td> 74<td><div class="variablelist"><table border="0" class="variablelist compact"> 75<colgroup> 76<col align="left" valign="top"> 77<col> 78</colgroup> 79<tbody> 80<tr> 81<td><p><span class="term"><code class="computeroutput">b</code></span></p></td> 82<td><p>A user-defined buffer that will be filled with the binary representation of serialized objects.</p></td> 83</tr> 84<tr> 85<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> 86<td><p>The communicator over which this archive will be sent.</p></td> 87</tr> 88<tr> 89<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> 90<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags.</p></td> 91</tr> 92</tbody> 93</table></div></td> 94</tr></tbody> 95</table></div> 96</li> 97<li class="listitem"> 98<pre class="literallayout"><a name="id-1_3_27_7_19_2_1_1_6-bb"></a><span class="identifier">packed_oarchive</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> 99 <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> 100<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_oarchive.html" title="Class packed_oarchive">packed_oarchive</a></code></code> for transmission over the given MPI communicator.</p> 101<p> 102</p> 103<div class="variablelist"><table border="0" class="variablelist compact"> 104<colgroup> 105<col align="left" valign="top"> 106<col> 107</colgroup> 108<tbody><tr> 109<td><p><span class="term">Parameters:</span></p></td> 110<td><div class="variablelist"><table border="0" class="variablelist compact"> 111<colgroup> 112<col align="left" valign="top"> 113<col> 114</colgroup> 115<tbody> 116<tr> 117<td><p><span class="term"><code class="computeroutput">comm</code></span></p></td> 118<td><p>The communicator over which this archive will be sent.</p></td> 119</tr> 120<tr> 121<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> 122<td><p>Control the serialization of the data types. Refer to the Boost.Serialization documentation before changing the default flags. </p></td> 123</tr> 124</tbody> 125</table></div></td> 126</tr></tbody> 127</table></div> 128</li> 129</ol></div> 130</div> 131<div class="refsect2"> 132<a name="id-1.3.27.7.20.4.4.4"></a><h3> 133<a name="id-1_3_27_7_19_2_1_1_4-bb"></a><code class="computeroutput">packed_oarchive</code> public member functions</h3> 134<div class="orderedlist"><ol class="orderedlist" type="1"> 135<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_19_2_1_1_4_1-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</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> 136<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_19_2_1_1_4_2-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</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> 137<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_19_2_1_1_4_3-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span> <span class="special">&</span> x<span class="special">)</span><span class="special">;</span></pre></li> 138<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_19_2_1_1_4_4-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</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> 139<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_19_2_1_1_4_5-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</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> 140<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_19_2_1_1_4_6-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</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> 141<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_27_7_19_2_1_1_4_7-bb"></a><span class="identifier">save_override</span><span class="special">(</span><span class="keyword">const</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> 142</ol></div> 143</div> 144</div> 145</div> 146<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 147<td align="left"></td> 148<td align="right"><div class="copyright-footer">Copyright © 2005-2007 Douglas Gregor, 149 Matthias Troyer, Trustees of Indiana University<p> 150 Distributed under the Boost Software License, Version 1.0. (See accompanying 151 file LICENSE_1_0.txt or copy at <ulink url="http://www.boost.org/LICENSE_1_0.txt"> 152 http://www.boost.org/LICENSE_1_0.txt </ulink>) 153 </p> 154</div></td> 155</tr></table> 156<hr> 157<div class="spirit-nav"> 158<a accesskey="p" href="packed_iarchive.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.packed_oarchive_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="python/register_serialized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 159</div> 160</body> 161</html> 162
