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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class status</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.status_hpp" title="Header <boost/mpi/status.hpp>">
<link rel="prev" href="get_content.html" title="Function template get_content">
<link rel="next" href="timer.html" title="Class timer">
</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="get_content.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.status_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="timer.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class status">
<a name="boost.mpi.status"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class status</span></h2>
<p>boost::mpi::status — Contains information about a message that has been or can be received. </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.status_hpp" title="Header <boost/mpi/status.hpp>">boost/mpi/status.hpp</a>>
</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="status.html" title="Class status">status</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="status.html#boost.mpi.statusconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="status.html#id897775-bb">status</a>();
<a class="link" href="status.html#id897776-bb">status</a>(MPI_Status <span class="bold"><strong>const</strong></span> &);
<span class="emphasis"><em>// <a class="link" href="status.html#id897638-bb">public member functions</a></em></span>
<span class="type"><span class="bold"><strong>int</strong></span></span> <a class="link" href="status.html#id897642-bb">source</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>int</strong></span></span> <a class="link" href="status.html#id897654-bb">tag</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>int</strong></span></span> <a class="link" href="status.html#id897665-bb">error</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="status.html#id897677-bb">cancelled</a>() <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type">optional< <span class="bold"><strong>int</strong></span> ></span> <a class="link" href="status.html#id897689-bb">count</a>() <span class="bold"><strong>const</strong></span>;
<a class="link" href="status.html#id897744-bb"><span class="bold"><strong>operator</strong></span> MPI_Status &</a>() ;
<a class="link" href="status.html#id897759-bb"><span class="bold"><strong>operator</strong></span> <span class="bold"><strong>const</strong></span> MPI_Status &</a>() <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>mutable</strong></span> <span class="type"><span class="bold"><strong>int</strong></span></span> m_count;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1414793"></a><h2>Description</h2>
<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>
<div class="refsect2" title="status public construct/copy/destruct">
<a name="id1414822"></a><h3>
<a name="boost.mpi.statusconstruct-copy-destruct"></a><code class="computeroutput">status</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id897775-bb"></a>status();</pre></li>
<li class="listitem"><pre class="literallayout"><a name="id897776-bb"></a>status(MPI_Status <span class="bold"><strong>const</strong></span> & s);</pre></li>
</ol></div>
</div>
<div class="refsect2" title="status public member functions">
<a name="id1414873"></a><h3>
<a name="id897638-bb"></a><code class="computeroutput">status</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>int</strong></span></span> <a name="id897642-bb"></a>source() <span class="bold"><strong>const</strong></span>;</pre>
<p>Retrieve the source of the message. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id897654-bb"></a>tag() <span class="bold"><strong>const</strong></span>;</pre>
<p>Retrieve the message tag. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id897665-bb"></a>error() <span class="bold"><strong>const</strong></span>;</pre>
<p>Retrieve the error code. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id897677-bb"></a>cancelled() <span class="bold"><strong>const</strong></span>;</pre>
<p>Determine whether the communication associated with this object has been successfully cancelled. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> T> <span class="type">optional< <span class="bold"><strong>int</strong></span> ></span> <a name="id897689-bb"></a>count() <span class="bold"><strong>const</strong></span>;</pre>
<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<T></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<int></code>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Returns:</span></p></td>
<td><p>the number of <code class="computeroutput">T</code> elements in the message, if it can be determined. </p></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id897744-bb"></a><span class="bold"><strong>operator</strong></span> MPI_Status &() ;</pre>
<p>References the underlying <code class="computeroutput">MPI_Status</code> </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id897759-bb"></a><span class="bold"><strong>operator</strong></span> <span class="bold"><strong>const</strong></span> MPI_Status &() <span class="bold"><strong>const</strong></span>;</pre>
<p>References the underlying <code class="computeroutput">MPI_Status</code> </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="get_content.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../mpi/reference.html#header.boost.mpi.status_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="timer.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
