mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
311 lines
18 KiB
HTML
311 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: FairMQParts Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.2.0</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="classFairMQParts-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQParts Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> is a lightweight convenience wrapper around a vector of unique pointers to <a class="el" href="classFairMQMessage.html">FairMQMessage</a>, used for sending multi-part messages.
|
|
<a href="classFairMQParts.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="FairMQParts_8h_source.html">FairMQParts.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aba59eef845e9f33f573363ec9dc5fde6"><td class="memItemLeft" align="right" valign="top"><a id="aba59eef845e9f33f573363ec9dc5fde6"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>iterator</b> = container::iterator</td></tr>
|
|
<tr class="separator:aba59eef845e9f33f573363ec9dc5fde6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d552f5cecf278a0b01d6e9dc390fec6"><td class="memItemLeft" align="right" valign="top"><a id="a7d552f5cecf278a0b01d6e9dc390fec6"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>const_iterator</b> = container::const_iterator</td></tr>
|
|
<tr class="separator:a7d552f5cecf278a0b01d6e9dc390fec6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aba451752ac510bd547a52b4ebb160789"><td class="memItemLeft" align="right" valign="top"><a id="aba451752ac510bd547a52b4ebb160789"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789">FairMQParts</a> ()</td></tr>
|
|
<tr class="memdesc:aba451752ac510bd547a52b4ebb160789"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:aba451752ac510bd547a52b4ebb160789"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a188cc956da9212b48f2954f275781c66"><td class="memItemLeft" align="right" valign="top"><a id="a188cc956da9212b48f2954f275781c66"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a188cc956da9212b48f2954f275781c66">FairMQParts</a> (const <a class="el" href="classFairMQParts.html">FairMQParts</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a188cc956da9212b48f2954f275781c66"><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor. <br /></td></tr>
|
|
<tr class="separator:a188cc956da9212b48f2954f275781c66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f0385790d55f0c44a3f667fd4352d83"><td class="memItemLeft" align="right" valign="top"><a id="a8f0385790d55f0c44a3f667fd4352d83"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a8f0385790d55f0c44a3f667fd4352d83">FairMQParts</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &&p)=default</td></tr>
|
|
<tr class="memdesc:a8f0385790d55f0c44a3f667fd4352d83"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a8f0385790d55f0c44a3f667fd4352d83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2b948ae748efc9f4ec7889e98b71278"><td class="memItemLeft" align="right" valign="top"><a id="ac2b948ae748efc9f4ec7889e98b71278"></a>
|
|
<a class="el" href="classFairMQParts.html">FairMQParts</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#ac2b948ae748efc9f4ec7889e98b71278">operator=</a> (const <a class="el" href="classFairMQParts.html">FairMQParts</a> &)=delete</td></tr>
|
|
<tr class="memdesc:ac2b948ae748efc9f4ec7889e98b71278"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
|
|
<tr class="separator:ac2b948ae748efc9f4ec7889e98b71278"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ddccbfb56041b6b95c31838acb02e69"><td class="memItemLeft" align="right" valign="top"><a id="a0ddccbfb56041b6b95c31838acb02e69"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a0ddccbfb56041b6b95c31838acb02e69">~FairMQParts</a> ()</td></tr>
|
|
<tr class="memdesc:a0ddccbfb56041b6b95c31838acb02e69"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a0ddccbfb56041b6b95c31838acb02e69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afaaa0eedc7a2c1e9fa6bec33dd1f3709"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#afaaa0eedc7a2c1e9fa6bec33dd1f3709">AddPart</a> (<a class="el" href="classFairMQMessage.html">FairMQMessage</a> *msg)</td></tr>
|
|
<tr class="separator:afaaa0eedc7a2c1e9fa6bec33dd1f3709"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2202b446893b2b247f6e042e3fa7cba5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a2202b446893b2b247f6e042e3fa7cba5">AddPart</a> (std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > &&msg)</td></tr>
|
|
<tr class="separator:a2202b446893b2b247f6e042e3fa7cba5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a309dcf53e2003614e8fed7cec4cfcb48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFairMQMessage.html">FairMQMessage</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a309dcf53e2003614e8fed7cec4cfcb48">operator[]</a> (const int index)</td></tr>
|
|
<tr class="separator:a309dcf53e2003614e8fed7cec4cfcb48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7fdb59ead8736caebaafd8861d6d7bd"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#ac7fdb59ead8736caebaafd8861d6d7bd">At</a> (const int index)</td></tr>
|
|
<tr class="separator:ac7fdb59ead8736caebaafd8861d6d7bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4de814ed00269ed9d4c1c8800ca5092"><td class="memItemLeft" align="right" valign="top"><a id="aa4de814ed00269ed9d4c1c8800ca5092"></a>
|
|
<a class="el" href="classFairMQMessage.html">FairMQMessage</a> & </td><td class="memItemRight" valign="bottom"><b>AtRef</b> (const int index)</td></tr>
|
|
<tr class="separator:aa4de814ed00269ed9d4c1c8800ca5092"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e3301192a6e033b98b5abfd563a45f3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQParts.html#a1e3301192a6e033b98b5abfd563a45f3">Size</a> () const</td></tr>
|
|
<tr class="separator:a1e3301192a6e033b98b5abfd563a45f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc82aaba75f99580ff05275b3c7bf38c"><td class="memItemLeft" align="right" valign="top"><a id="afc82aaba75f99580ff05275b3c7bf38c"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>begin</b> () -> decltype(fParts.begin())</td></tr>
|
|
<tr class="separator:afc82aaba75f99580ff05275b3c7bf38c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa851fb350cc3ea2c7c97dae4b11085af"><td class="memItemLeft" align="right" valign="top"><a id="aa851fb350cc3ea2c7c97dae4b11085af"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>end</b> () -> decltype(fParts.end())</td></tr>
|
|
<tr class="separator:aa851fb350cc3ea2c7c97dae4b11085af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad297c1abf81069ddef8775c5657680dd"><td class="memItemLeft" align="right" valign="top"><a id="ad297c1abf81069ddef8775c5657680dd"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>cbegin</b> () -> decltype(fParts.cbegin())</td></tr>
|
|
<tr class="separator:ad297c1abf81069ddef8775c5657680dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afde4db5c1ccf902e0886736c6d47d784"><td class="memItemLeft" align="right" valign="top"><a id="afde4db5c1ccf902e0886736c6d47d784"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><b>cend</b> () -> decltype(fParts.cend())</td></tr>
|
|
<tr class="separator:afde4db5c1ccf902e0886736c6d47d784"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a38b4265065fae1f330de6470578e2ee4"><td class="memItemLeft" align="right" valign="top"><a id="a38b4265065fae1f330de6470578e2ee4"></a>
|
|
container </td><td class="memItemRight" valign="bottom"><b>fParts</b></td></tr>
|
|
<tr class="separator:a38b4265065fae1f330de6470578e2ee4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> is a lightweight convenience wrapper around a vector of unique pointers to <a class="el" href="classFairMQMessage.html">FairMQMessage</a>, used for sending multi-part messages. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="afaaa0eedc7a2c1e9fa6bec33dd1f3709"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afaaa0eedc7a2c1e9fa6bec33dd1f3709">◆ </a></span>AddPart() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQParts::AddPart </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQMessage.html">FairMQMessage</a> * </td>
|
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Adds part (<a class="el" href="classFairMQMessage.html">FairMQMessage</a>) to the container </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>message pointer (for example created with NewMessage() method of <a class="el" href="classFairMQDevice.html">FairMQDevice</a>) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2202b446893b2b247f6e042e3fa7cba5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2202b446893b2b247f6e042e3fa7cba5">◆ </a></span>AddPart() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQParts::AddPart </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classFairMQMessage.html">FairMQMessage</a> > && </td>
|
|
<td class="paramname"><em>msg</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Adds part (std::unique_ptr<FairMQMessage>&) to the container (move) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>unique pointer to <a class="el" href="classFairMQMessage.html">FairMQMessage</a> lvalue ref (move not required when passing argument) Adds part (std::unique_ptr<FairMQMessage>&) to the container (move) </td></tr>
|
|
<tr><td class="paramname">msg</td><td>unique pointer to <a class="el" href="classFairMQMessage.html">FairMQMessage</a> rvalue ref (move required when passing argument) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7fdb59ead8736caebaafd8861d6d7bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7fdb59ead8736caebaafd8861d6d7bd">◆ </a></span>At()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<<a class="el" href="classFairMQMessage.html">FairMQMessage</a>>& FairMQParts::At </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get reference to unique pointer to part in the container at index (with bounds check) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>container index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a309dcf53e2003614e8fed7cec4cfcb48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a309dcf53e2003614e8fed7cec4cfcb48">◆ </a></span>operator[]()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classFairMQMessage.html">FairMQMessage</a>& FairMQParts::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get reference to part in the container at index (without bounds check) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>container index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1e3301192a6e033b98b5abfd563a45f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1e3301192a6e033b98b5abfd563a45f3">◆ </a></span>Size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQParts::Size </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get number of parts in the container </p><dl class="section return"><dt>Returns</dt><dd>number of parts in the container </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>fairmq/<a class="el" href="FairMQParts_8h_source.html">FairMQParts.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|