Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 16:46:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
6d82d305b9
FairMQ/v1.3.9/runFairMQDevice_8h_source.html
Dennis Klein 95b8ff7858
Add API docs for 1.3.9
2019-08-07 18:00:46 +02:00

81 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: fairmq/runFairMQDevice.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.9</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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">runFairMQDevice.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) 2017 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">#include &lt;fairmq/DeviceRunner.h&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;boost/program_options.hpp&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">using</span> <a class="code" href="classFairMQDevice.html">FairMQDevicePtr</a> = <a class="code" href="classFairMQDevice.html">FairMQDevice</a>*;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// to be implemented by the user to return a child class of FairMQDevice</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<a class="code" href="classFairMQDevice.html">FairMQDevicePtr</a> getDevice(<span class="keyword">const</span> <a class="code" href="classFairMQProgOptions.html">FairMQProgOptions</a>&amp; config);</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// to be implemented by the user to add custom command line options (or just with empty body)</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keywordtype">void</span> addCustomOptions(boost::program_options::options_description&amp;);</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="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[])</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">using namespace </span>fair::mq;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">using namespace </span>fair::mq::hooks;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">try</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">fair::mq::DeviceRunner</a> runner{argc, argv};</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// runner.AddHook&lt;LoadPlugins&gt;([](DeviceRunner&amp; r){</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// // for example:</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// r.fPluginManager-&gt;SetSearchPaths({&quot;/lib&quot;, &quot;/lib/plugins&quot;});</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// r.fPluginManager-&gt;LoadPlugin(&quot;asdf&quot;);</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// });</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; runner.AddHook&lt;<a class="code" href="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions.html">SetCustomCmdLineOptions</a>&gt;([](<a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a>&amp; r){</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; boost::program_options::options_description customOptions(<span class="stringliteral">&quot;Custom options&quot;</span>);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; addCustomOptions(customOptions);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; r.fConfig.AddToCmdLineOptions(customOptions);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; });</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; <span class="comment">// runner.AddHook&lt;ModifyRawCmdLineArgs&gt;([](DeviceRunner&amp; r){</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// // for example:</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// r.fRawCmdLineArgs.push_back(&quot;--blubb&quot;);</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// });</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; runner.AddHook&lt;<a class="code" href="structfair_1_1mq_1_1hooks_1_1InstantiateDevice.html">InstantiateDevice</a>&gt;([](<a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a>&amp; r){</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; r.fDevice = std::unique_ptr&lt;FairMQDevice&gt;{getDevice(r.fConfig)};</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; });</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> runner.Run();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Run with builtin catch all exception handler, just:</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// return runner.RunWithExceptionHandlers();</span></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; <span class="keywordflow">catch</span> (std::exception&amp; e)</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; LOG(error) &lt;&lt; <span class="stringliteral">&quot;Uncaught exception reached the top of main: &quot;</span> &lt;&lt; e.what();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">catch</span> (...)</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; LOG(error) &lt;&lt; <span class="stringliteral">&quot;Uncaught exception reached the top of main.&quot;</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> 1;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;}</div><div class="ttc" id="classfair_1_1mq_1_1DeviceRunner_html"><div class="ttname"><a href="classfair_1_1mq_1_1DeviceRunner.html">fair::mq::DeviceRunner</a></div><div class="ttdoc">Utility class to facilitate a convenient top-level device launch/shutdown.</div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:51</div></div>
<div class="ttc" id="classFairMQProgOptions_html"><div class="ttname"><a href="classFairMQProgOptions.html">FairMQProgOptions</a></div><div class="ttdef"><b>Definition:</b> FairMQProgOptions.h:37</div></div>
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1InstantiateDevice_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1InstantiateDevice.html">fair::mq::hooks::InstantiateDevice</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:84</div></div>
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions.html">fair::mq::hooks::SetCustomCmdLineOptions</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:82</div></div>
<div class="ttc" id="classFairMQDevice_html"><div class="ttname"><a href="classFairMQDevice.html">FairMQDevice</a></div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:46</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