doc/html/boost/mpi/packed_skeleton_iarchive.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class packed_skeleton_iarchive</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../mpi/reference.html#header.boost.mpi.skeleton_and_content_hpp" title="Header &lt;boost/mpi/skeleton_and_content.hpp&gt;">
   9 <link rel="prev" href="content.html" title="Class content">
  10 <link rel="next" href="packed_skeleton_oarchive.html" title="Class packed_skeleton_oarchive">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="content.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.skeleton_and_content_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_skeleton_oarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.mpi.packed_skeleton_iarchive"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class packed_skeleton_iarchive</span></h2>
  29 <p>boost::mpi::packed_skeleton_iarchive &#8212; An archiver that reconstructs a data structure based on the binary skeleton stored in a buffer. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../mpi/reference.html#header.boost.mpi.skeleton_and_content_hpp" title="Header &lt;boost/mpi/skeleton_and_content.hpp&gt;">boost/mpi/skeleton_and_content.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="packed_skeleton_iarchive.html#boost.mpi.packed_skeleton_iarchiveconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="packed_skeleton_iarchive.html#id785236-bb"><span class="identifier">packed_skeleton_iarchive</span></a><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span>
  39                            <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>
  40   <span class="keyword">explicit</span> <a class="link" href="packed_skeleton_iarchive.html#id785274-bb"><span class="identifier">packed_skeleton_iarchive</span></a><span class="special">(</span><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="packed_skeleton_iarchive.html#id785202-bb">public member functions</a></span>
  43   <span class="keyword">const</span> <a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span> <a class="link" href="packed_skeleton_iarchive.html#id785205-bb"><span class="identifier">get_skeleton</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44   <a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span> <a class="link" href="packed_skeleton_iarchive.html#id785221-bb"><span class="identifier">get_skeleton</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="id2541764"></a><h2>Description</h2>
  48 <p>The <code class="computeroutput"><a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a></code> class is an Archiver (as in the Boost.Serialization library) that can construct the the shape of a data structure based on a binary skeleton stored in a buffer. The <code class="computeroutput"><a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a></code> is typically used by the receiver of a skeleton, to prepare a data structure that will eventually receive content separately.</p>
  49 <p>Users will not generally need to use <code class="computeroutput"><a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a></code> directly. Instead, use <code class="computeroutput">skeleton</code> or <code class="computeroutput">get_skeleton</code>. </p>
  50 <div class="refsect2">
  51 <a name="id2541823"></a><h3>
  52 <a name="boost.mpi.packed_skeleton_iarchiveconstruct-copy-destruct"></a><code class="computeroutput">packed_skeleton_iarchive</code>
  53         public
  54        construct/copy/destruct</h3>
  55 <div class="orderedlist"><ol class="orderedlist" type="1">
  56 <li class="listitem">
  57 <pre class="literallayout"><a name="id785236-bb"></a><span class="identifier">packed_skeleton_iarchive</span><span class="special">(</span><span class="identifier">MPI_Comm</span> <span class="keyword">const</span> <span class="special">&amp;</span> comm<span class="special">,</span>
  58                          <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>
  59 <p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a></code></code> for the given communicator.</p>
  60 <p>
  61 </p>
  62 <div class="variablelist"><table border="0">
  63 <col align="left" valign="top">
  64 <tbody><tr>
  65 <td><p><span class="term">Parameters:</span></p></td>
  66 <td><div class="variablelist"><table border="0">
  67 <col align="left" valign="top">
  68 <tbody>
  69 <tr>
  70 <td><p><span class="term"><code class="computeroutput">comm</code></span></p></td>
  71 <td><p>The communicator over which this archive will be transmitted.</p></td>
  72 </tr>
  73 <tr>
  74 <td><p><span class="term"><code class="computeroutput">flags</code></span></p></td>
  75 <td><p>Control the serialization of the skeleton. Refer to the Boost.Serialization documentation before changing the default flags. </p></td>
  76 </tr>
  77 </tbody>
  78 </table></div></td>
  79 </tr></tbody>
  80 </table></div>
  81 </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="keyword">explicit</span> <a name="id785274-bb"></a><span class="identifier">packed_skeleton_iarchive</span><span class="special">(</span><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span> archive<span class="special">)</span><span class="special">;</span></pre>
  84 <p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="packed_skeleton_iarchive.html" title="Class packed_skeleton_iarchive">packed_skeleton_iarchive</a></code></code> that unpacks a skeleton from the given <code class="computeroutput">archive</code>.</p>
  85 <p>
  86 </p>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody><tr>
  90 <td><p><span class="term">Parameters:</span></p></td>
  91 <td><div class="variablelist"><table border="0">
  92 <col align="left" valign="top">
  93 <tbody><tr>
  94 <td><p><span class="term"><code class="computeroutput">archive</code></span></p></td>
  95 <td><p>the archive from which the skeleton will be unpacked. </p></td>
  96 </tr></tbody>
  97 </table></div></td>
  98 </tr></tbody>
  99 </table></div>
 100 </li>
 101 </ol></div>
 102 </div>
 103 <div class="refsect2">
 104 <a name="id2542091"></a><h3>
 105 <a name="id785202-bb"></a><code class="computeroutput">packed_skeleton_iarchive</code> public member functions</h3>
 106 <div class="orderedlist"><ol class="orderedlist" type="1">
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">const</span> <a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span> <a name="id785205-bb"></a><span class="identifier">get_skeleton</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 109 <p>Retrieve the archive corresponding to this skeleton. </p>
 110 </li>
 111 <li class="listitem">
 112 <pre class="literallayout"><a class="link" href="packed_iarchive.html" title="Class packed_iarchive">packed_iarchive</a> <span class="special">&amp;</span> <a name="id785221-bb"></a><span class="identifier">get_skeleton</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 113 <p>Retrieve the archive corresponding to this skeleton. </p>
 114 </li>
 115 </ol></div>
 116 </div>
 117 </div>
 118 </div>
 119 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 120 <td align="left"></td>
 121 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
 122       Matthias Troyer, Trustees of Indiana University<p>
 123         Distributed under the Boost Software License, Version 1.0. (See accompanying
 124         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">
 125         http://www.boost.org/LICENSE_1_0.txt </a>)
 126       </p>
 127 </div></td>
 128 </tr></table>
 129 <hr>
 130 <div class="spirit-nav">
 131 <a accesskey="p" href="content.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.skeleton_and_content_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_skeleton_oarchive.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 132 </div>
 133 </body>
 134 </html>