mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
103 lines
38 KiB
HTML
103 lines
38 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: fairmq/Plugin.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
|
|
 <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 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">Plugin.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIR_MQ_PLUGIN_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_PLUGIN_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <fairmq/Tools.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fairmq/PluginServices.h></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <boost/dll/alias.hpp></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <boost/optional.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <boost/program_options.hpp></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ostream></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <tuple></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1Plugin.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">using</span> ProgOptions = boost::optional<boost::program_options::options_description>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">Version</a> = <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">tools::Version</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>(<span class="keyword">const</span> std::string name, <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">Version</a> version, <span class="keyword">const</span> std::string maintainer, <span class="keyword">const</span> std::string homepage, <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>* pluginServices);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a> operator=(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">auto</span> GetName() <span class="keyword">const</span> -> <span class="keyword">const</span> std::string& { <span class="keywordflow">return</span> fkName; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">auto</span> GetVersion() <span class="keyword">const</span> -> <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">Version</a> { <span class="keywordflow">return</span> fkVersion; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">auto</span> GetMaintainer() <span class="keyword">const</span> -> <span class="keyword">const</span> std::string& { <span class="keywordflow">return</span> fkMaintainer; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">auto</span> GetHomepage() <span class="keyword">const</span> -> <span class="keyword">const</span> std::string& { <span class="keywordflow">return</span> fkHomepage; }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator==(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>& lhs, <span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>& rhs) -> <span class="keywordtype">bool</span> { <span class="keywordflow">return</span> std::make_tuple(lhs.GetName(), lhs.GetVersion()) == std::make_tuple(rhs.GetName(), rhs.GetVersion()); }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator!=(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>& lhs, <span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>& rhs) -> <span class="keywordtype">bool</span> { <span class="keywordflow">return</span> !(lhs == rhs); }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator<<(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a>& p) -> std::ostream&</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> os << <span class="stringliteral">"'"</span> << p.GetName() << <span class="stringliteral">"', "</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  << <span class="stringliteral">"version '"</span> << p.GetVersion() << <span class="stringliteral">"', "</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  << <span class="stringliteral">"maintainer '"</span> << p.GetMaintainer() << <span class="stringliteral">"', "</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  << <span class="stringliteral">"homepage '"</span> << p.GetHomepage() << <span class="stringliteral">"'"</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keyword">auto</span> NoProgramOptions() -> ProgOptions { <span class="keywordflow">return</span> boost::none; }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// device control API</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// see <fairmq/PluginServices.h> for docs</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">using</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">DeviceState</a> = <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">fair::mq::PluginServices::DeviceState</a>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">using</span> DeviceStateTransition = fair::mq::PluginServices::DeviceStateTransition;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">auto</span> ToDeviceState(<span class="keyword">const</span> std::string& state) <span class="keyword">const</span> -> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">DeviceState</a> { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#aba55018cac4ae8341f491c662c482130">ToDeviceState</a>(state); }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">auto</span> ToDeviceStateTransition(<span class="keyword">const</span> std::string& transition) <span class="keyword">const</span> -> DeviceStateTransition { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a7f74475cef8ab1c39b87f8948b35e0a0">ToDeviceStateTransition</a>(transition); }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">auto</span> ToStr(<a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">DeviceState</a> state) <span class="keyword">const</span> -> std::string { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69">ToStr</a>(state); }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">auto</span> ToStr(DeviceStateTransition transition) <span class="keyword">const</span> -> std::string { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69">ToStr</a>(transition); }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">auto</span> GetCurrentDeviceState() <span class="keyword">const</span> -> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">DeviceState</a> { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#ac93964a0e35ca0ed91bfbaab6405be82">GetCurrentDeviceState</a>(); }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">auto</span> TakeDeviceControl() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#ab2bab89d575dd90828d492cf2d0d2f5e">TakeDeviceControl</a>(fkName); };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">auto</span> StealDeviceControl() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a546360c16172c5d3c83f483871fa0c7e">StealDeviceControl</a>(fkName); };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">auto</span> ReleaseDeviceControl() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#af7127f156ba970298a23b8b67550a43b">ReleaseDeviceControl</a>(fkName); };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">auto</span> ChangeDeviceState(<span class="keyword">const</span> DeviceStateTransition next) -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#ab2470014e7d85a1d82ed636bd84f95e8">ChangeDeviceState</a>(fkName, next); }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">auto</span> SubscribeToDeviceStateChange(std::function<<span class="keywordtype">void</span>(<a class="code" href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">DeviceState</a>)> callback) -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449">SubscribeToDeviceStateChange</a>(fkName, callback); }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">auto</span> UnsubscribeFromDeviceStateChange() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a657506e2afe946ada3deff4ecc40e4d1">UnsubscribeFromDeviceStateChange</a>(fkName); }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// device config API</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// see <fairmq/PluginServices.h> for docs</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">auto</span> PropertyExists(<span class="keyword">const</span> std::string& key) -> <span class="keywordtype">int</span> { <span class="keywordflow">return</span> fPluginServices->PropertyExists(key); }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">auto</span> SetProperty(<span class="keyword">const</span> std::string& key, T val) -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#ae06ecdf4d79d3a1e7d850dfab4239200">SetProperty</a>(key, val); }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">auto</span> GetProperty(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> -> T { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359">GetProperty</a><T>(key); }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">auto</span> GetPropertyAsString(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> -> std::string { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a49179c80826ae5ec87d77b8d50d8ec44">GetPropertyAsString</a>(key); }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">auto</span> GetChannelInfo() <span class="keyword">const</span> -> std::unordered_map<std::string, int> { <span class="keywordflow">return</span> fPluginServices->GetChannelInfo(); }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">auto</span> GetPropertyKeys() <span class="keyword">const</span> -> std::vector<std::string> { <span class="keywordflow">return</span> fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a4e090fa0029724f23a1ef3fcacb928d2">GetPropertyKeys</a>(); }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">auto</span> SubscribeToPropertyChange(std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::string& key, T newValue)> callback) -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#abd34c038f5c3c94338419bbd887f3d14">SubscribeToPropertyChange</a><T>(fkName, callback); }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">auto</span> UnsubscribeFromPropertyChange() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1b96fc3f61efccfa5c2048eb578b60e5">UnsubscribeFromPropertyChange</a><T>(fkName); }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">auto</span> SubscribeToPropertyChangeAsString(std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::string& key, std::string newValue)> callback) -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#ad6c37fce55cb631d9f5be45b93a544f9">SubscribeToPropertyChangeAsString</a>(fkName, callback); }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">auto</span> UnsubscribeFromPropertyChangeAsString() -> <span class="keywordtype">void</span> { fPluginServices-><a class="code" href="classfair_1_1mq_1_1PluginServices.html#a746aba1505ae9117a28886de85111e16">UnsubscribeFromPropertyChangeAsString</a>(fkName); }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> std::string fkName;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">Version</a> fkVersion;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> std::string fkMaintainer;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> std::string fkHomepage;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>* fPluginServices;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }; <span class="comment">/* class Plugin */</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#define REGISTER_FAIRMQ_PLUGIN(KLASS, NAME, VERSION, MAINTAINER, HOMEPAGE, PROGOPTIONS) \</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">static auto Make_##NAME##_Plugin(fair::mq::PluginServices* pluginServices) -> std::shared_ptr<fair::mq::Plugin> \</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">{ \</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"> return std::make_shared<KLASS>(std::string{#NAME}, VERSION, std::string{MAINTAINER}, std::string{HOMEPAGE}, pluginServices); \</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">} \</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">BOOST_DLL_ALIAS(Make_##NAME##_Plugin, make_##NAME##_plugin) \</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">BOOST_DLL_ALIAS(PROGOPTIONS, get_##NAME##_plugin_progoptions)</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PLUGIN_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1PluginServices_html"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html">fair::mq::PluginServices</a></div><div class="ttdoc">Facilitates communication between devices and plugins. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:37</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a546360c16172c5d3c83f483871fa0c7e"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a546360c16172c5d3c83f483871fa0c7e">fair::mq::PluginServices::StealDeviceControl</a></div><div class="ttdeci">auto StealDeviceControl(const std::string &controller) -> void</div><div class="ttdoc">Become device controller by force. </div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:133</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a1b96fc3f61efccfa5c2048eb578b60e5"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a1b96fc3f61efccfa5c2048eb578b60e5">fair::mq::PluginServices::UnsubscribeFromPropertyChange</a></div><div class="ttdeci">auto UnsubscribeFromPropertyChange(const std::string &subscriber) -> void</div><div class="ttdoc">Unsubscribe from property updates of type T. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:240</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_ab2bab89d575dd90828d492cf2d0d2f5e"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ab2bab89d575dd90828d492cf2d0d2f5e">fair::mq::PluginServices::TakeDeviceControl</a></div><div class="ttdeci">auto TakeDeviceControl(const std::string &controller) -> void</div><div class="ttdoc">Become device controller. </div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:112</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_abd34c038f5c3c94338419bbd887f3d14"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#abd34c038f5c3c94338419bbd887f3d14">fair::mq::PluginServices::SubscribeToPropertyChange</a></div><div class="ttdeci">auto SubscribeToPropertyChange(const std::string &subscriber, std::function< void(const std::string &key, T)> callback) const -> void</div><div class="ttdoc">Subscribe to property updates of type T. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:232</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a657506e2afe946ada3deff4ecc40e4d1"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a657506e2afe946ada3deff4ecc40e4d1">fair::mq::PluginServices::UnsubscribeFromDeviceStateChange</a></div><div class="ttdeci">auto UnsubscribeFromDeviceStateChange(const std::string &subscriber) -> void</div><div class="ttdoc">Unsubscribe from device state changes. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:165</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a1ed12471e1736e2545645f3a12238d69"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69">fair::mq::PluginServices::ToStr</a></div><div class="ttdeci">static auto ToStr(DeviceState state) -> std::string</div><div class="ttdoc">Convert DeviceState to string. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:101</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_ac93964a0e35ca0ed91bfbaab6405be82"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ac93964a0e35ca0ed91bfbaab6405be82">fair::mq::PluginServices::GetCurrentDeviceState</a></div><div class="ttdeci">auto GetCurrentDeviceState() const -> DeviceState</div><div class="ttdef"><b>Definition:</b> PluginServices.h:112</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a49179c80826ae5ec87d77b8d50d8ec44"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a49179c80826ae5ec87d77b8d50d8ec44">fair::mq::PluginServices::GetPropertyAsString</a></div><div class="ttdeci">auto GetPropertyAsString(const std::string &key) const -> std::string</div><div class="ttdoc">Read config property as string. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:213</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1Plugin_html"><div class="ttname"><a href="classfair_1_1mq_1_1Plugin.html">fair::mq::Plugin</a></div><div class="ttdoc">Base class for FairMQ plugins. </div><div class="ttdef"><b>Definition:</b> Plugin.h:38</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_af7127f156ba970298a23b8b67550a43b"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#af7127f156ba970298a23b8b67550a43b">fair::mq::PluginServices::ReleaseDeviceControl</a></div><div class="ttdeci">auto ReleaseDeviceControl(const std::string &controller) -> void</div><div class="ttdoc">Release device controller role. </div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:140</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a98b235e5119d863dbb7adeb00938d449"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449">fair::mq::PluginServices::SubscribeToDeviceStateChange</a></div><div class="ttdeci">auto SubscribeToDeviceStateChange(const std::string &subscriber, std::function< void(DeviceState)> callback) -> void</div><div class="ttdoc">Subscribe with a callback to device state changes. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:156</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_aba55018cac4ae8341f491c662c482130"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#aba55018cac4ae8341f491c662c482130">fair::mq::PluginServices::ToDeviceState</a></div><div class="ttdeci">static auto ToDeviceState(const std::string &state) -> DeviceState</div><div class="ttdoc">Convert string to DeviceState. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:90</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_adc2f2ddc5a3e2d6a5846672d40cac359"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359">fair::mq::PluginServices::GetProperty</a></div><div class="ttdeci">auto GetProperty(const std::string &key) const -> T</div><div class="ttdoc">Read config property. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:201</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_ad6c37fce55cb631d9f5be45b93a544f9"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ad6c37fce55cb631d9f5be45b93a544f9">fair::mq::PluginServices::SubscribeToPropertyChangeAsString</a></div><div class="ttdeci">auto SubscribeToPropertyChangeAsString(const std::string &subscriber, std::function< void(const std::string &key, std::string)> callback) const -> void</div><div class="ttdoc">Subscribe to property updates. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:247</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a614eb15c3272895a09e5f2da46e367a7"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a614eb15c3272895a09e5f2da46e367a7">fair::mq::PluginServices::DeviceState</a></div><div class="ttdeci">DeviceState</div><div class="ttdoc">See https://github.com/FairRootGroup/FairRoot/blob/dev/fairmq/docs/Device.md#13-state-machine. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:54</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_ae06ecdf4d79d3a1e7d850dfab4239200"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ae06ecdf4d79d3a1e7d850dfab4239200">fair::mq::PluginServices::SetProperty</a></div><div class="ttdeci">auto SetProperty(const std::string &key, T val) -> void</div><div class="ttdoc">Set config property. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:180</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a746aba1505ae9117a28886de85111e16"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a746aba1505ae9117a28886de85111e16">fair::mq::PluginServices::UnsubscribeFromPropertyChangeAsString</a></div><div class="ttdeci">auto UnsubscribeFromPropertyChangeAsString(const std::string &subscriber) -> void</div><div class="ttdoc">Unsubscribe from property updates that convert to string. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:254</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a7f74475cef8ab1c39b87f8948b35e0a0"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a7f74475cef8ab1c39b87f8948b35e0a0">fair::mq::PluginServices::ToDeviceStateTransition</a></div><div class="ttdeci">static auto ToDeviceStateTransition(const std::string &transition) -> DeviceStateTransition</div><div class="ttdoc">Convert string to DeviceStateTransition. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:96</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a4e090fa0029724f23a1ef3fcacb928d2"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a4e090fa0029724f23a1ef3fcacb928d2">fair::mq::PluginServices::GetPropertyKeys</a></div><div class="ttdeci">auto GetPropertyKeys() const -> std::vector< std::string ></div><div class="ttdoc">Discover the list of property keys. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:224</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_ab2470014e7d85a1d82ed636bd84f95e8"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ab2470014e7d85a1d82ed636bd84f95e8">fair::mq::PluginServices::ChangeDeviceState</a></div><div class="ttdeci">auto ChangeDeviceState(const std::string &controller, const DeviceStateTransition next) -> void</div><div class="ttdoc">Request a device state transition. </div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:93</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1tools_1_1Version_html"><div class="ttname"><a href="structfair_1_1mq_1_1tools_1_1Version.html">fair::mq::tools::Version</a></div><div class="ttdef"><b>Definition:</b> Version.h:22</div></div>
|
|
</div><!-- fragment --></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>
|