doc/html/boost/mpi/status.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class status</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.status_hpp" title="Header &lt;boost/mpi/status.hpp&gt;">
   9 <link rel="prev" href="get_content.html" title="Function template get_content">
  10 <link rel="next" href="timer.html" title="Class timer">
  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="get_content.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.status_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="timer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.mpi.status"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class status</span></h2>
  29 <p>boost::mpi::status &#8212; Contains information about a message that has been or can be received. </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.status_hpp" title="Header &lt;boost/mpi/status.hpp&gt;">boost/mpi/status.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="status.html" title="Class status">status</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="status.html#boost.mpi.statusconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="status.html#id775860-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="status.html#id775861-bb"><span class="identifier">status</span></a><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="status.html#id775724-bb">public member functions</a></span>
  42   <span class="keyword">int</span> <a class="link" href="status.html#id775727-bb"><span class="identifier">source</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <span class="keyword">int</span> <a class="link" href="status.html#id775739-bb"><span class="identifier">tag</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44   <span class="keyword">int</span> <a class="link" href="status.html#id775750-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="keyword">bool</span> <a class="link" href="status.html#id775762-bb"><span class="identifier">cancelled</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">optional</span><span class="special">&lt;</span> <span class="keyword">int</span> <span class="special">&gt;</span> <a class="link" href="status.html#id775775-bb"><span class="identifier">count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <a class="link" href="status.html#id775829-bb"><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&amp;</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="status.html#id775844-bb"><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&amp;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49
  50   <span class="comment">// public data members</span>
  51   <span class="keyword">mutable</span> <span class="keyword">int</span> <span class="identifier">m_count</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="id2495762"></a><h2>Description</h2>
  55 <p>This structure contains status information about messages that have been received (with <code class="computeroutput">communicator::recv</code>) or can be received (returned from <code class="computeroutput">communicator::probe</code> or <code class="computeroutput">communicator::iprobe</code>). It permits access to the source of the message, message tag, error code (rarely used), or the number of elements that have been transmitted. </p>
  56 <div class="refsect2">
  57 <a name="id2495791"></a><h3>
  58 <a name="boost.mpi.statusconstruct-copy-destruct"></a><code class="computeroutput">status</code>
  59         public
  60        construct/copy/destruct</h3>
  61 <div class="orderedlist"><ol class="orderedlist" type="1">
  62 <li class="listitem"><pre class="literallayout"><a name="id775860-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  63 <li class="listitem"><pre class="literallayout"><a name="id775861-bb"></a><span class="identifier">status</span><span class="special">(</span><span class="identifier">MPI_Status</span> <span class="keyword">const</span> <span class="special">&amp;</span> s<span class="special">)</span><span class="special">;</span></pre></li>
  64 </ol></div>
  65 </div>
  66 <div class="refsect2">
  67 <a name="id2495885"></a><h3>
  68 <a name="id775724-bb"></a><code class="computeroutput">status</code> public member functions</h3>
  69 <div class="orderedlist"><ol class="orderedlist" type="1">
  70 <li class="listitem">
  71 <pre class="literallayout"><span class="keyword">int</span> <a name="id775727-bb"></a><span class="identifier">source</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  72 <p>Retrieve the source of the message. </p>
  73 </li>
  74 <li class="listitem">
  75 <pre class="literallayout"><span class="keyword">int</span> <a name="id775739-bb"></a><span class="identifier">tag</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  76 <p>Retrieve the message tag. </p>
  77 </li>
  78 <li class="listitem">
  79 <pre class="literallayout"><span class="keyword">int</span> <a name="id775750-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  80 <p>Retrieve the error code. </p>
  81 </li>
  82 <li class="listitem">
  83 <pre class="literallayout"><span class="keyword">bool</span> <a name="id775762-bb"></a><span class="identifier">cancelled</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  84 <p>Determine whether the communication associated with this object has been successfully cancelled. </p>
  85 </li>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">optional</span><span class="special">&lt;</span> <span class="keyword">int</span> <span class="special">&gt;</span> <a name="id775775-bb"></a><span class="identifier">count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  88 <p>Determines the number of elements of type <code class="computeroutput">T</code> contained in the message. The type <code class="computeroutput">T</code> must have an associated data type, i.e., <code class="computeroutput">is_mpi_datatype&lt;T&gt;</code> must derive <code class="computeroutput">mpl::true_</code>. In cases where the type <code class="computeroutput">T</code> does not match the transmitted type, this routine will return an empty <code class="computeroutput">optional&lt;int&gt;</code>.</p>
  89 <p>
  90 </p>
  91 <div class="variablelist"><table border="0">
  92 <col align="left" valign="top">
  93 <tbody><tr>
  94 <td><p><span class="term">Returns:</span></p></td>
  95 <td><p>the number of <code class="computeroutput">T</code> elements in the message, if it can be determined. </p></td>
  96 </tr></tbody>
  97 </table></div>
  98 </li>
  99 <li class="listitem">
 100 <pre class="literallayout"><a name="id775829-bb"></a><span class="keyword">operator</span> <span class="identifier">MPI_Status</span> <span class="special">&amp;</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 101 <p>References the underlying <code class="computeroutput">MPI_Status</code> </p>
 102 </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><a name="id775844-bb"></a><span class="keyword">operator</span> <span class="keyword">const</span> <span class="identifier">MPI_Status</span> <span class="special">&amp;</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 105 <p>References the underlying <code class="computeroutput">MPI_Status</code> </p>
 106 </li>
 107 </ol></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2007 Douglas Gregor,
 114       Matthias Troyer, Trustees of Indiana University<p>
 115         Distributed under the Boost Software License, Version 1.0. (See accompanying
 116         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">
 117         http://www.boost.org/LICENSE_1_0.txt </a>)
 118       </p>
 119 </div></td>
 120 </tr></table>
 121 <hr>
 122 <div class="spirit-nav">
 123 <a accesskey="p" href="get_content.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.status_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="timer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 124 </div>
 125 </body>
 126 </html>