mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
288 lines
62 KiB
HTML
288 lines
62 KiB
HTML
<!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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/PluginServices.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.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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">PluginServices.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_PLUGINSERVICES_H</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_PLUGINSERVICES_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/States.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <FairMQDevice.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <fairmq/ProgOptions.h></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <fairmq/Properties.h></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <boost/optional.hpp></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <boost/optional/optional_io.hpp></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <condition_variable></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <map></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <mutex></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <stdexcept></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <unordered_map></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <vector></span></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><a class="code" href="namespacefair_1_1mq.html">fair::mq</a></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="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>PluginServices</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  PluginServices() = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  PluginServices(ProgOptions& config, <a class="code" href="classFairMQDevice.html">FairMQDevice</a>& device)</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  : fConfig(config)</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html"> 45</a></span>  , fDevice(device)</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  , fDeviceController()</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  , fDeviceControllerMutex()</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  , fReleaseDeviceControlCondition()</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</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>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ~<a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>()</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  LOG(debug) << <span class="stringliteral">"Shutting down Plugin Services"</span>;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  PluginServices(<span class="keyword">const</span> PluginServices&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  PluginServices operator=(<span class="keyword">const</span> PluginServices&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">using</span> DeviceState = fair::mq::State;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">using</span> DeviceStateTransition = fair::mq::Transition;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Control API</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#aba55018cac4ae8341f491c662c482130">ToDeviceState</a>(<span class="keyword">const</span> std::string& state) -> DeviceState { <span class="keywordflow">return</span> GetState(state); }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#aba55018cac4ae8341f491c662c482130"> 75</a></span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a7f74475cef8ab1c39b87f8948b35e0a0">ToDeviceStateTransition</a>(<span class="keyword">const</span> std::string& transition) -> DeviceStateTransition { <span class="keywordflow">return</span> GetTransition(transition); }</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69">ToStr</a>(DeviceState state) -> std::string { <span class="keywordflow">return</span> GetStateName(state); }</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a7f74475cef8ab1c39b87f8948b35e0a0"> 81</a></span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69">ToStr</a>(DeviceStateTransition transition) -> std::string { <span class="keywordflow">return</span> GetTransitionName(transition); }</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69"> 86</a></span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ac93964a0e35ca0ed91bfbaab6405be82">GetCurrentDeviceState</a>() const -> DeviceState { <span class="keywordflow">return</span> fDevice.<a class="code" href="classFairMQDevice.html#a7ba52b2fc3908c6bf1391eb5f27b03bd">GetCurrentState</a>(); }</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ab2bab89d575dd90828d492cf2d0d2f5e">TakeDeviceControl</a>(<span class="keyword">const</span> std::string& controller) -> void;</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">struct </span>DeviceControlError : std::runtime_error { <span class="keyword">using</span> std::runtime_error::runtime_error; };</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a546360c16172c5d3c83f483871fa0c7e">StealDeviceControl</a>(<span class="keyword">const</span> std::string& controller) -> void;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#af7127f156ba970298a23b8b67550a43b">ReleaseDeviceControl</a>(<span class="keyword">const</span> std::string& controller) -> void;</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#aba93554ad3553a1d14d1affd85e1dea1">GetDeviceController</a>() const -> boost::optional<std::<span class="keywordtype">string</span>>;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  auto <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a79645639828ffaebcb81e29dc49ca6a4">WaitForReleaseDeviceControl</a>() -> <span class="keywordtype">void</span>;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  auto <a class="code" href="classfair_1_1mq_1_1PluginServices.html#adb2b7857434e48018dfe6b17044dcef9">ChangeDeviceState</a>(const std::<span class="keywordtype">string</span>& controller, const DeviceStateTransition next) -> <span class="keywordtype">bool</span>;</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  auto <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449">SubscribeToDeviceStateChange</a>(const std::<span class="keywordtype">string</span>& subscriber, std::function<<span class="keywordtype">void</span>(DeviceState <span class="comment">/*newState*/</span>)> callback) -> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  {</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  fDevice.<a class="code" href="classFairMQDevice.html#ae3c2c8524082bf37eafaa26030ee7452">SubscribeToStateChange</a>(subscriber, [&,callback](fair::mq::State newState){</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  callback(newState);</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  });</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449"> 138</a></span>  </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a657506e2afe946ada3deff4ecc40e4d1">UnsubscribeFromDeviceStateChange</a>(<span class="keyword">const</span> std::string& subscriber) -> <span class="keywordtype">void</span> { fDevice.<a class="code" href="classFairMQDevice.html#af9b5b7a5469bff53feb6a1e000230e73">UnsubscribeFromStateChange</a>(subscriber); }</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// Config API</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1ab97f8394a3e1552277ff2564e16c6a">PropertyExists</a>(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> -> <span class="keywordtype">bool</span> { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a95494fa84eea46fae7c666f0b82f7048">Count</a>(key) > 0; }</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ae06ecdf4d79d3a1e7d850dfab4239200">SetProperty</a>(<span class="keyword">const</span> std::string& key, T val) -> <span class="keywordtype">void</span> { fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c">SetProperty</a>(key, val); }</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ad186ca529c4c374d35d9229019e83e10">SetProperties</a>(<span class="keyword">const</span> fair::mq::Properties& props) { fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ae9f743fc76dee8566eb843640120e8f3">SetProperties</a>(props); }</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">bool</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a4622c8b748222585a14de5623eea4cd2">UpdateProperty</a>(<span class="keyword">const</span> std::string& key, T val) { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2">UpdateProperty</a>(key, val); }</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">bool</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a56f00de35770ed226b3d9c467c6b0f6e">UpdateProperties</a>(<span class="keyword">const</span> fair::mq::Properties& input) { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a6b014a8adcf80aa6fe8b3471e87f13e6">UpdateProperties</a>(input); }</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  </div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#aea4d010d8cecae6e801df6308e8f6197">DeleteProperty</a>(<span class="keyword">const</span> std::string& key) { fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a8e9af05d7ca5f7ac372971a9c7450195">DeleteProperty</a>(key); }</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#aea4d010d8cecae6e801df6308e8f6197"> 178</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359">GetProperty</a>(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> -> T { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a><T>(key); }</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359"> 184</a></span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  T <a class="code" href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359">GetProperty</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> T& ifNotFound)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a>(key, ifNotFound); }</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a49179c80826ae5ec87d77b8d50d8ec44">GetPropertyAsString</a>(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> -> std::string { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a9d0a829555bafa0f19a3f072aa5d0097">GetPropertyAsString</a>(key); }</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a49179c80826ae5ec87d77b8d50d8ec44">GetPropertyAsString</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> std::string& ifNotFound) <span class="keyword">const</span> -> std::string { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a9d0a829555bafa0f19a3f072aa5d0097">GetPropertyAsString</a>(key, ifNotFound); }</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  fair::mq::Properties <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a352fad62f282e921b0c722dfcbaaa73d">GetProperties</a>(<span class="keyword">const</span> std::string& q)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a59e98e064e01188e0e52b9ae6f2f83a2">GetProperties</a>(q); }</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a352fad62f282e921b0c722dfcbaaa73d"> 215</a></span>  fair::mq::Properties <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a9f48923e4b80022827bd416ffe8f38bc">GetPropertiesStartingWith</a>(<span class="keyword">const</span> std::string& q)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a69e8c85c5d7778f361244ae554af9f5b">GetPropertiesStartingWith</a>(q); }</div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  std::map<std::string, std::string> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#af4d3fd1caf8beffefc992b89e7479007">GetPropertiesAsString</a>(<span class="keyword">const</span> std::string& q)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#abcbfe2950b7cf1239cbc7fcf085a8f01">GetPropertiesAsString</a>(q); }</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#af4d3fd1caf8beffefc992b89e7479007"> 225</a></span>  std::map<std::string, std::string> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a118417e34fd4f398e77f7f5fe7153661">GetPropertiesAsStringStartingWith</a>(<span class="keyword">const</span> std::string& q)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#aad0d6d0e82c486c9ba09ae5a3e0e4f25">GetPropertiesAsStringStartingWith</a>(q); }</div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  </div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ab966df2353bbce792a5b938f420080c0">GetChannelInfo</a>() const -> std::unordered_map<std::<span class="keywordtype">string</span>, <span class="keywordtype">int</span>> { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#af890f73cfd75cdf5189be7fa936c7bf0">GetChannelInfo</a>(); }</div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  </div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a4e090fa0029724f23a1ef3fcacb928d2">GetPropertyKeys</a>() const -> std::vector<std::<span class="keywordtype">string</span>> { <span class="keywordflow">return</span> fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a67ef979cc694a245f28084389b8cffc0">GetPropertyKeys</a>(); }</div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  </div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#abd34c038f5c3c94338419bbd887f3d14">SubscribeToPropertyChange</a>(<span class="keyword">const</span> std::string& subscriber, std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::string& key, T)> callback) <span class="keyword">const</span> -> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  {</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43">Subscribe</a><T>(subscriber, callback);</div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  }</div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a1b96fc3f61efccfa5c2048eb578b60e5">UnsubscribeFromPropertyChange</a>(<span class="keyword">const</span> std::string& subscriber) -> <span class="keywordtype">void</span> { fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a">Unsubscribe</a><T>(subscriber); }</div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  </div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ad6c37fce55cb631d9f5be45b93a544f9">SubscribeToPropertyChangeAsString</a>(<span class="keyword">const</span> std::string& subscriber, std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::string& key, std::string)> callback) <span class="keyword">const</span> -> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  {</div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184">SubscribeAsString</a>(subscriber, callback);</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  }</div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  </div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a746aba1505ae9117a28886de85111e16">UnsubscribeFromPropertyChangeAsString</a>(<span class="keyword">const</span> std::string& subscriber) -> <span class="keywordtype">void</span> { fConfig.<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae">UnsubscribeAsString</a>(subscriber); }</div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  </div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a7e4ee07b3e64aca15079165f94ef4580">CycleLogConsoleSeverityUp</a>() -> <span class="keywordtype">void</span> { Logger::CycleConsoleSeverityUp(); }</div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a69294d8b0771e3b65d4d4157c4559c52">CycleLogConsoleSeverityDown</a>() -> <span class="keywordtype">void</span> { Logger::CycleConsoleSeverityDown(); }</div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a364225377b53067f0bfa1e006fbe069e">CycleLogVerbosityUp</a>() -> <span class="keywordtype">void</span> { Logger::CycleVerbosityUp(); }</div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a7e4ee07b3e64aca15079165f94ef4580"> 272</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a95095ff2174a531e48d83ee1cfa293d5">CycleLogVerbosityDown</a>() -> <span class="keywordtype">void</span> { Logger::CycleVerbosityDown(); }</div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  </div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a69294d8b0771e3b65d4d4157c4559c52"> 274</a></span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <a class="code" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a>& fConfig;</div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a364225377b53067f0bfa1e006fbe069e"> 276</a></span>  <a class="code" href="classFairMQDevice.html">FairMQDevice</a>& fDevice;</div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  boost::optional<std::string> fDeviceController;</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a95095ff2174a531e48d83ee1cfa293d5"> 278</a></span>  <span class="keyword">mutable</span> std::mutex fDeviceControllerMutex;</div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  std::condition_variable fReleaseDeviceControlCondition;</div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> }; <span class="comment">/* class PluginServices */</span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  </div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> } <span class="comment">// namespace fair::mq</span></div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  </div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PLUGINSERVICES_H */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassfair_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:163</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a69294d8b0771e3b65d4d4157c4559c52"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a69294d8b0771e3b65d4d4157c4559c52">fair::mq::PluginServices::CycleLogConsoleSeverityDown</a></div><div class="ttdeci">auto CycleLogConsoleSeverityDown() -> void</div><div class="ttdoc">Decreases console logging severity, or sets it to highest if it is already lowest.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:274</div></div>
|
|
<div class="ttc" id="aclassfair_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:94</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a></div><div class="ttdef"><b>Definition:</b> ProgOptions.h:41</div></div>
|
|
<div class="ttc" id="aclassfair_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:269</div></div>
|
|
<div class="ttc" id="aclassfair_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:46</div></div>
|
|
<div class="ttc" id="aclassFairMQDevice_html_a7ba52b2fc3908c6bf1391eb5f27b03bd"><div class="ttname"><a href="classFairMQDevice.html#a7ba52b2fc3908c6bf1391eb5f27b03bd">FairMQDevice::GetCurrentState</a></div><div class="ttdeci">fair::mq::State GetCurrentState() const</div><div class="ttdoc">Returns the current state.</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:473</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a67ef979cc694a245f28084389b8cffc0"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a67ef979cc694a245f28084389b8cffc0">fair::mq::ProgOptions::GetPropertyKeys</a></div><div class="ttdeci">std::vector< std::string > GetPropertyKeys() const</div><div class="ttdoc">Discover the list of property keys.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:189</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_adb2b7857434e48018dfe6b17044dcef9"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#adb2b7857434e48018dfe6b17044dcef9">fair::mq::PluginServices::ChangeDeviceState</a></div><div class="ttdeci">auto ChangeDeviceState(const std::string &controller, const DeviceStateTransition next) -> bool</div><div class="ttdoc">Request a device state transition.</div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:15</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a69e8c85c5d7778f361244ae554af9f5b"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a69e8c85c5d7778f361244ae554af9f5b">fair::mq::ProgOptions::GetPropertiesStartingWith</a></div><div class="ttdeci">fair::mq::Properties GetPropertiesStartingWith(const std::string &q) const</div><div class="ttdoc">Read several config properties whose keys start with the provided string.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:256</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a95467b4bdb44c73cf960a60ff0457df2"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2">fair::mq::ProgOptions::UpdateProperty</a></div><div class="ttdeci">bool UpdateProperty(const std::string &key, T val)</div><div class="ttdoc">Updates an existing config property (or fails if it doesn't exist)</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:152</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a95095ff2174a531e48d83ee1cfa293d5"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a95095ff2174a531e48d83ee1cfa293d5">fair::mq::PluginServices::CycleLogVerbosityDown</a></div><div class="ttdeci">auto CycleLogVerbosityDown() -> void</div><div class="ttdoc">Decreases logging verbosity, or sets it to highest if it is already lowest.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:278</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a7e4ee07b3e64aca15079165f94ef4580"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a7e4ee07b3e64aca15079165f94ef4580">fair::mq::PluginServices::CycleLogConsoleSeverityUp</a></div><div class="ttdeci">auto CycleLogConsoleSeverityUp() -> void</div><div class="ttdoc">Increases console logging severity, or sets it to lowest if it is already highest.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:272</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_af5afa61b1a9eebb4a9558da3fc8b576a"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a">fair::mq::ProgOptions::Unsubscribe</a></div><div class="ttdeci">void Unsubscribe(const std::string &subscriber) const</div><div class="ttdoc">Unsubscribe from property updates of type T.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:202</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a9f48923e4b80022827bd416ffe8f38bc"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a9f48923e4b80022827bd416ffe8f38bc">fair::mq::PluginServices::GetPropertiesStartingWith</a></div><div class="ttdeci">fair::mq::Properties GetPropertiesStartingWith(const std::string &q) const</div><div class="ttdoc">Read several config properties whose keys start with the provided string.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:221</div></div>
|
|
<div class="ttc" id="anamespacefair_1_1mq_html"><div class="ttname"><a href="namespacefair_1_1mq.html">fair::mq</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators.</div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
<div class="ttc" id="aclassfair_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:239</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_aba93554ad3553a1d14d1affd85e1dea1"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#aba93554ad3553a1d14d1affd85e1dea1">fair::mq::PluginServices::GetDeviceController</a></div><div class="ttdeci">auto GetDeviceController() const -> boost::optional< std::string ></div><div class="ttdoc">Get current device controller.</div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:70</div></div>
|
|
<div class="ttc" id="aclassfair_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:138</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_ab68955211261d786ddec42aa986484ac"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">fair::mq::ProgOptions::GetProperty</a></div><div class="ttdeci">T GetProperty(const std::string &key) const</div><div class="ttdoc">Read config property, throw if no property with this key exists.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:69</div></div>
|
|
<div class="ttc" id="aclassfair_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:75</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a4622c8b748222585a14de5623eea4cd2"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a4622c8b748222585a14de5623eea4cd2">fair::mq::PluginServices::UpdateProperty</a></div><div class="ttdeci">bool UpdateProperty(const std::string &key, T val)</div><div class="ttdoc">Updates an existing config property (or fails if it doesn't exist)</div><div class="ttdef"><b>Definition:</b> PluginServices.h:171</div></div>
|
|
<div class="ttc" id="aclassfair_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:81</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a56f00de35770ed226b3d9c467c6b0f6e"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a56f00de35770ed226b3d9c467c6b0f6e">fair::mq::PluginServices::UpdateProperties</a></div><div class="ttdeci">bool UpdateProperties(const fair::mq::Properties &input)</div><div class="ttdoc">Updates multiple existing config properties (or fails of any of then do not exist,...</div><div class="ttdef"><b>Definition:</b> PluginServices.h:174</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_aea4d010d8cecae6e801df6308e8f6197"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#aea4d010d8cecae6e801df6308e8f6197">fair::mq::PluginServices::DeleteProperty</a></div><div class="ttdeci">void DeleteProperty(const std::string &key)</div><div class="ttdoc">Deletes a property with the given key from the config store.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:178</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a118417e34fd4f398e77f7f5fe7153661"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a118417e34fd4f398e77f7f5fe7153661">fair::mq::PluginServices::GetPropertiesAsStringStartingWith</a></div><div class="ttdeci">std::map< std::string, std::string > GetPropertiesAsStringStartingWith(const std::string &q) const</div><div class="ttdoc">Read several config properties as string whose keys start with the provided string.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:231</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a9d0a829555bafa0f19a3f072aa5d0097"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a9d0a829555bafa0f19a3f072aa5d0097">fair::mq::ProgOptions::GetPropertyAsString</a></div><div class="ttdeci">std::string GetPropertyAsString(const std::string &key) const</div><div class="ttdoc">Read config property as string, throw if no property with this key exists.</div></div>
|
|
<div class="ttc" id="aclassfair_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:31</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a272f25798b948992a560df32d405517c"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c">fair::mq::ProgOptions::SetProperty</a></div><div class="ttdeci">void SetProperty(const std::string &key, T val)</div><div class="ttdoc">Set config property.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:136</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_abcbfe2950b7cf1239cbc7fcf085a8f01"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#abcbfe2950b7cf1239cbc7fcf085a8f01">fair::mq::ProgOptions::GetPropertiesAsString</a></div><div class="ttdeci">std::map< std::string, std::string > GetPropertiesAsString(const std::string &q) const</div><div class="ttdoc">Read several config properties as string whose keys match the provided regular expression.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:271</div></div>
|
|
<div class="ttc" id="aclassfair_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:147</div></div>
|
|
<div class="ttc" id="aclassfair_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:247</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a79645639828ffaebcb81e29dc49ca6a4"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a79645639828ffaebcb81e29dc49ca6a4">fair::mq::PluginServices::WaitForReleaseDeviceControl</a></div><div class="ttdeci">auto WaitForReleaseDeviceControl() -> void</div><div class="ttdoc">Block until control is released.</div><div class="ttdef"><b>Definition:</b> PluginServices.cxx:77</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a3de4a0e1a29cdeccd54e67da544ab184"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184">fair::mq::ProgOptions::SubscribeAsString</a></div><div class="ttdeci">void SubscribeAsString(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) const</div><div class="ttdoc">Subscribe to property updates, with values converted to string.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:213</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a364225377b53067f0bfa1e006fbe069e"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a364225377b53067f0bfa1e006fbe069e">fair::mq::PluginServices::CycleLogVerbosityUp</a></div><div class="ttdeci">auto CycleLogVerbosityUp() -> void</div><div class="ttdoc">Increases logging verbosity, or sets it to lowest if it is already highest.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:276</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_af4d3fd1caf8beffefc992b89e7479007"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#af4d3fd1caf8beffefc992b89e7479007">fair::mq::PluginServices::GetPropertiesAsString</a></div><div class="ttdeci">std::map< std::string, std::string > GetPropertiesAsString(const std::string &q) const</div><div class="ttdoc">Read several config properties as string whose keys match the provided regular expression.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:225</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a1ab97f8394a3e1552277ff2564e16c6a"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a1ab97f8394a3e1552277ff2564e16c6a">fair::mq::PluginServices::PropertyExists</a></div><div class="ttdeci">auto PropertyExists(const std::string &key) const -> bool</div><div class="ttdoc">Checks a property with the given key exist in the configuration.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:154</div></div>
|
|
<div class="ttc" id="aclassFairMQDevice_html_ae3c2c8524082bf37eafaa26030ee7452"><div class="ttname"><a href="classFairMQDevice.html#ae3c2c8524082bf37eafaa26030ee7452">FairMQDevice::SubscribeToStateChange</a></div><div class="ttdeci">void SubscribeToStateChange(const std::string &key, std::function< void(const fair::mq::State)> callback)</div><div class="ttdoc">Subscribe with a callback to state changes.</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:454</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a6b014a8adcf80aa6fe8b3471e87f13e6"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a6b014a8adcf80aa6fe8b3471e87f13e6">fair::mq::ProgOptions::UpdateProperties</a></div><div class="ttdeci">bool UpdateProperties(const fair::mq::Properties &input)</div><div class="ttdoc">Updates multiple existing config properties (or fails of any of then do not exist,...</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:323</div></div>
|
|
<div class="ttc" id="aclassfair_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:255</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_afbf4111312c5cd350dc7b924f8524c43"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43">fair::mq::ProgOptions::Subscribe</a></div><div class="ttdeci">void Subscribe(const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) const</div><div class="ttdoc">Subscribe to property updates of type T.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:191</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_ab966df2353bbce792a5b938f420080c0"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ab966df2353bbce792a5b938f420080c0">fair::mq::PluginServices::GetChannelInfo</a></div><div class="ttdeci">auto GetChannelInfo() const -> std::unordered_map< std::string, int ></div><div class="ttdoc">Retrieve current channel information.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:235</div></div>
|
|
<div class="ttc" id="aclassfair_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, throw if no property with this key exists.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:200</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_af5a595dbee8a9331d33e0cd3eaefb4ae"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae">fair::mq::ProgOptions::UnsubscribeAsString</a></div><div class="ttdeci">void UnsubscribeAsString(const std::string &subscriber) const</div><div class="ttdoc">Unsubscribe from property updates that convert to string.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:221</div></div>
|
|
<div class="ttc" id="aclassfair_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:47</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_aad0d6d0e82c486c9ba09ae5a3e0e4f25"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#aad0d6d0e82c486c9ba09ae5a3e0e4f25">fair::mq::ProgOptions::GetPropertiesAsStringStartingWith</a></div><div class="ttdeci">std::map< std::string, std::string > GetPropertiesAsStringStartingWith(const std::string &q) const</div><div class="ttdoc">Read several config properties as string whose keys start with the provided string.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:291</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_ae9f743fc76dee8566eb843640120e8f3"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#ae9f743fc76dee8566eb843640120e8f3">fair::mq::ProgOptions::SetProperties</a></div><div class="ttdeci">void SetProperties(const fair::mq::Properties &input)</div><div class="ttdoc">Set multiple config properties.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:306</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a59e98e064e01188e0e52b9ae6f2f83a2"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a59e98e064e01188e0e52b9ae6f2f83a2">fair::mq::ProgOptions::GetProperties</a></div><div class="ttdeci">fair::mq::Properties GetProperties(const std::string &q) const</div><div class="ttdoc">Read several config properties whose keys match the provided regular expression.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:236</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a95494fa84eea46fae7c666f0b82f7048"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a95494fa84eea46fae7c666f0b82f7048">fair::mq::ProgOptions::Count</a></div><div class="ttdeci">int Count(const std::string &key) const</div><div class="ttdoc">Checks a property with the given key exist in the configuration.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:155</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_a8e9af05d7ca5f7ac372971a9c7450195"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a8e9af05d7ca5f7ac372971a9c7450195">fair::mq::ProgOptions::DeleteProperty</a></div><div class="ttdeci">void DeleteProperty(const std::string &key)</div><div class="ttdoc">Deletes a property with the given key from the config store.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:349</div></div>
|
|
<div class="ttc" id="aclassfair_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:54</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_a352fad62f282e921b0c722dfcbaaa73d"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a352fad62f282e921b0c722dfcbaaa73d">fair::mq::PluginServices::GetProperties</a></div><div class="ttdeci">fair::mq::Properties GetProperties(const std::string &q) const</div><div class="ttdoc">Read several config properties whose keys match the provided regular expression.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:215</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1PluginServices_html_ad186ca529c4c374d35d9229019e83e10"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#ad186ca529c4c374d35d9229019e83e10">fair::mq::PluginServices::SetProperties</a></div><div class="ttdeci">void SetProperties(const fair::mq::Properties &props)</div><div class="ttdoc">Set multiple config properties.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:166</div></div>
|
|
<div class="ttc" id="aclassfair_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:262</div></div>
|
|
<div class="ttc" id="aclassfair_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, throw if no property with this key exists.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:184</div></div>
|
|
<div class="ttc" id="aclassFairMQDevice_html"><div class="ttname"><a href="classFairMQDevice.html">FairMQDevice</a></div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:50</div></div>
|
|
<div class="ttc" id="aclassFairMQDevice_html_af9b5b7a5469bff53feb6a1e000230e73"><div class="ttname"><a href="classFairMQDevice.html#af9b5b7a5469bff53feb6a1e000230e73">FairMQDevice::UnsubscribeFromStateChange</a></div><div class="ttdeci">void UnsubscribeFromStateChange(const std::string &key)</div><div class="ttdoc">Unsubscribe from state changes.</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:457</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_af890f73cfd75cdf5189be7fa936c7bf0"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#af890f73cfd75cdf5189be7fa936c7bf0">fair::mq::ProgOptions::GetChannelInfo</a></div><div class="ttdeci">std::unordered_map< std::string, int > GetChannelInfo() const</div><div class="ttdoc">Retrieve current channel information.</div><div class="ttdef"><b>Definition:</b> ProgOptions.cxx:161</div></div>
|
|
<div class="ttc" id="aclassfair_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:86</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|