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