Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 00:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.3.8/FairMQParts_8h_source.html
Dennis Klein f1c3c5f6c4
Add API docs for 1.3.8
2019-01-07 13:13:30 +01:00

86 lines
17 KiB
HTML
Raw Permalink Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fairmq/FairMQParts.h Source File</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
&#160;<span id="projectnumber">1.3.8</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">FairMQParts.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * copied verbatim in the file &quot;LICENSE&quot; *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef FAIRMQPARTS_H_</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define FAIRMQPARTS_H_</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;FairMQTransportFactory.h&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;FairMQMessage.h&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span> <span class="comment">// unique_ptr</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classFairMQParts.html"> 20</a></span>&#160;<span class="keyword">class </span><a class="code" href="classFairMQParts.html">FairMQParts</a></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">using</span> container = std::vector&lt;std::unique_ptr&lt;FairMQMessage&gt;&gt;;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789"> 27</a></span>&#160; <a class="code" href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789">FairMQParts</a>() : fParts() {};</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789">FairMQParts</a>(<span class="keyword">const</span> <a class="code" href="classFairMQParts.html">FairMQParts</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789">FairMQParts</a>(<a class="code" href="classFairMQParts.html">FairMQParts</a>&amp;&amp; p) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classFairMQParts.html">FairMQParts</a>&amp; <a class="code" href="classFairMQParts.html#ac2b948ae748efc9f4ec7889e98b71278">operator=</a>(<span class="keyword">const</span> <a class="code" href="classFairMQParts.html">FairMQParts</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classFairMQParts.html#a0ddccbfb56041b6b95c31838acb02e69"> 35</a></span>&#160; <a class="code" href="classFairMQParts.html#a0ddccbfb56041b6b95c31838acb02e69">~FairMQParts</a>() {};</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classFairMQParts.html#afaaa0eedc7a2c1e9fa6bec33dd1f3709"> 39</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classFairMQParts.html#afaaa0eedc7a2c1e9fa6bec33dd1f3709">AddPart</a>(<a class="code" href="classFairMQMessage.html">FairMQMessage</a>* msg)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; fParts.push_back(std::unique_ptr&lt;FairMQMessage&gt;(msg));</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">// inline void AddPart(std::unique_ptr&lt;FairMQMessage&gt;&amp; msg)</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// {</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// fParts.push_back(std::move(msg));</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// }</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classFairMQParts.html#a2202b446893b2b247f6e042e3fa7cba5"> 55</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classFairMQParts.html#a2202b446893b2b247f6e042e3fa7cba5">AddPart</a>(std::unique_ptr&lt;FairMQMessage&gt;&amp;&amp; msg)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; fParts.push_back(std::move(msg));</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classFairMQParts.html#a309dcf53e2003614e8fed7cec4cfcb48"> 62</a></span>&#160; <a class="code" href="classFairMQMessage.html">FairMQMessage</a>&amp; <a class="code" href="classFairMQParts.html#a309dcf53e2003614e8fed7cec4cfcb48">operator[]</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> index) { <span class="keywordflow">return</span> *(fParts[index]); }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classFairMQParts.html#ac7fdb59ead8736caebaafd8861d6d7bd"> 66</a></span>&#160; std::unique_ptr&lt;FairMQMessage&gt;&amp; <a class="code" href="classFairMQParts.html#ac7fdb59ead8736caebaafd8861d6d7bd">At</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> index) { <span class="keywordflow">return</span> fParts.at(index); }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">// ref version</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="classFairMQMessage.html">FairMQMessage</a>&amp; AtRef(<span class="keyword">const</span> <span class="keywordtype">int</span> index) { <span class="keywordflow">return</span> *(fParts.at(index)); }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classFairMQParts.html#a1e3301192a6e033b98b5abfd563a45f3"> 73</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classFairMQParts.html#a1e3301192a6e033b98b5abfd563a45f3">Size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fParts.size(); }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; container fParts;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// forward container iterators</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">using</span> iterator = container::iterator;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">using</span> const_iterator = container::const_iterator;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">auto</span> begin() -&gt; decltype(fParts.begin()) { <span class="keywordflow">return</span> fParts.begin(); }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">auto</span> end() -&gt; decltype(fParts.end()) { <span class="keywordflow">return</span> fParts.end(); }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">auto</span> cbegin() -&gt; decltype(fParts.cbegin()) { <span class="keywordflow">return</span> fParts.cbegin(); }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">auto</span> cend() -&gt; decltype(fParts.cend()) { <span class="keywordflow">return</span> fParts.cend(); }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;};</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FAIRMQPARTS_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classFairMQParts_html_a0ddccbfb56041b6b95c31838acb02e69"><div class="ttname"><a href="classFairMQParts.html#a0ddccbfb56041b6b95c31838acb02e69">FairMQParts::~FairMQParts</a></div><div class="ttdeci">~FairMQParts()</div><div class="ttdoc">Default destructor. </div><div class="ttdef"><b>Definition:</b> FairMQParts.h:35</div></div>
<div class="ttc" id="classFairMQParts_html_a309dcf53e2003614e8fed7cec4cfcb48"><div class="ttname"><a href="classFairMQParts.html#a309dcf53e2003614e8fed7cec4cfcb48">FairMQParts::operator[]</a></div><div class="ttdeci">FairMQMessage &amp; operator[](const int index)</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:62</div></div>
<div class="ttc" id="classFairMQParts_html_afaaa0eedc7a2c1e9fa6bec33dd1f3709"><div class="ttname"><a href="classFairMQParts.html#afaaa0eedc7a2c1e9fa6bec33dd1f3709">FairMQParts::AddPart</a></div><div class="ttdeci">void AddPart(FairMQMessage *msg)</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:39</div></div>
<div class="ttc" id="classFairMQParts_html_ac2b948ae748efc9f4ec7889e98b71278"><div class="ttname"><a href="classFairMQParts.html#ac2b948ae748efc9f4ec7889e98b71278">FairMQParts::operator=</a></div><div class="ttdeci">FairMQParts &amp; operator=(const FairMQParts &amp;)=delete</div><div class="ttdoc">Assignment operator. </div></div>
<div class="ttc" id="classFairMQParts_html_ac7fdb59ead8736caebaafd8861d6d7bd"><div class="ttname"><a href="classFairMQParts.html#ac7fdb59ead8736caebaafd8861d6d7bd">FairMQParts::At</a></div><div class="ttdeci">std::unique_ptr&lt; FairMQMessage &gt; &amp; At(const int index)</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:66</div></div>
<div class="ttc" id="classFairMQParts_html_a2202b446893b2b247f6e042e3fa7cba5"><div class="ttname"><a href="classFairMQParts.html#a2202b446893b2b247f6e042e3fa7cba5">FairMQParts::AddPart</a></div><div class="ttdeci">void AddPart(std::unique_ptr&lt; FairMQMessage &gt; &amp;&amp;msg)</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:55</div></div>
<div class="ttc" id="classFairMQParts_html_a1e3301192a6e033b98b5abfd563a45f3"><div class="ttname"><a href="classFairMQParts.html#a1e3301192a6e033b98b5abfd563a45f3">FairMQParts::Size</a></div><div class="ttdeci">int Size() const</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:73</div></div>
<div class="ttc" id="classFairMQParts_html"><div class="ttname"><a href="classFairMQParts.html">FairMQParts</a></div><div class="ttdoc">FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:20</div></div>
<div class="ttc" id="classFairMQParts_html_aba451752ac510bd547a52b4ebb160789"><div class="ttname"><a href="classFairMQParts.html#aba451752ac510bd547a52b4ebb160789">FairMQParts::FairMQParts</a></div><div class="ttdeci">FairMQParts()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> FairMQParts.h:27</div></div>
<div class="ttc" id="classFairMQMessage_html"><div class="ttname"><a href="classFairMQMessage.html">FairMQMessage</a></div><div class="ttdef"><b>Definition:</b> FairMQMessage.h:20</div></div>
</div><!-- fragment --></div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
Reference in New Issue View Git Blame Copy Permalink