mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
116 lines
55 KiB
HTML
116 lines
55 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/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.14</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.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">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 <functional></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <unordered_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 <map></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <stdexcept></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html"> 40</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>(<a class="code" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a>& config, <a class="code" href="classFairMQDevice.html">FairMQDevice</a>& device)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  : fConfig(config)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  , fDevice(device)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  , fDeviceController()</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  , fDeviceControllerMutex()</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  , fReleaseDeviceControlCondition()</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> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  ~<a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>()</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  LOG(debug) << <span class="stringliteral">"Shutting down Plugin Services"</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> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a> operator=(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">using</span> DeviceState = fair::mq::State;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">using</span> DeviceStateTransition = fair::mq::Transition;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Control API</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#aba55018cac4ae8341f491c662c482130"> 70</a></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="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a7f74475cef8ab1c39b87f8948b35e0a0"> 76</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="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a1ed12471e1736e2545645f3a12238d69"> 81</a></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="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#aa12e9fe01d4285d31576ef3418098698"> 86</a></span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#aa12e9fe01d4285d31576ef3418098698">ToStr</a>(DeviceStateTransition transition) -> std::string { <span class="keywordflow">return</span> GetTransitionName(transition); }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#ac93964a0e35ca0ed91bfbaab6405be82"> 89</a></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.GetCurrentState(); }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</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="l00097"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1PluginServices_1_1DeviceControlError.html"> 97</a></span>  <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1PluginServices_1_1DeviceControlError.html">DeviceControlError</a> : std::runtime_error { <span class="keyword">using</span> std::runtime_error::runtime_error; };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</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="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#aba93554ad3553a1d14d1affd85e1dea1">GetDeviceController</a>() <span class="keyword">const</span> -> boost::optional<std::string>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a79645639828ffaebcb81e29dc49ca6a4">WaitForReleaseDeviceControl</a>() -> void;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#adb2b7857434e48018dfe6b17044dcef9">ChangeDeviceState</a>(<span class="keyword">const</span> std::string& controller, <span class="keyword">const</span> DeviceStateTransition next) -> bool;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449"> 133</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a98b235e5119d863dbb7adeb00938d449">SubscribeToDeviceStateChange</a>(<span class="keyword">const</span> std::string& 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="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  fDevice.SubscribeToStateChange(subscriber, [&,callback](fair::mq::State newState){</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  callback(newState);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  });</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a657506e2afe946ada3deff4ecc40e4d1"> 142</a></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.UnsubscribeFromStateChange(subscriber); }</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// Config API</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a1ab97f8394a3e1552277ff2564e16c6a"> 149</a></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.Count(key) > 0; }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#ae06ecdf4d79d3a1e7d850dfab4239200"> 158</a></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.SetProperty(key, val); }</div><div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#ad186ca529c4c374d35d9229019e83e10"> 161</a></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.SetProperties(props); }</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a4622c8b748222585a14de5623eea4cd2"> 166</a></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.UpdateProperty(key, val); }</div><div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a56f00de35770ed226b3d9c467c6b0f6e"> 169</a></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.UpdateProperties(input); }</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#aea4d010d8cecae6e801df6308e8f6197"> 173</a></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.DeleteProperty(key); }</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#adc2f2ddc5a3e2d6a5846672d40cac359"> 179</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.GetProperty<T>(key); }</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a65971490d4b0a9d0a3dfe0303b4c454b"> 186</a></span>  T <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a65971490d4b0a9d0a3dfe0303b4c454b">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.GetProperty(key, ifNotFound); }</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00195"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a49179c80826ae5ec87d77b8d50d8ec44"> 195</a></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.GetPropertyAsString(key); }</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00205"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#acc0aec32c563c0c0db3fd865a3e89f53"> 205</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#acc0aec32c563c0c0db3fd865a3e89f53">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.GetPropertyAsString(key, ifNotFound); }</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div><div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a352fad62f282e921b0c722dfcbaaa73d"> 210</a></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.GetProperties(q); }</div><div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a9f48923e4b80022827bd416ffe8f38bc"> 216</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.GetPropertiesStartingWith(q); }</div><div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#af4d3fd1caf8beffefc992b89e7479007"> 220</a></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.GetPropertiesAsString(q); }</div><div class="line"><a name="l00226"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a118417e34fd4f398e77f7f5fe7153661"> 226</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.GetPropertiesAsStringStartingWith(q); }</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00230"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#ab966df2353bbce792a5b938f420080c0"> 230</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#ab966df2353bbce792a5b938f420080c0">GetChannelInfo</a>() const -> <a class="code" href="namespacestd.html">std</a>::unordered_map<<a class="code" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>, <span class="keywordtype">int</span>> { <span class="keywordflow">return</span> fConfig.GetChannelInfo(); }</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a4e090fa0029724f23a1ef3fcacb928d2"> 234</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1PluginServices.html#a4e090fa0029724f23a1ef3fcacb928d2">GetPropertyKeys</a>() const -> <a class="code" href="namespacestd.html">std</a>::vector<<a class="code" href="namespacestd.html">std</a>::<span class="keywordtype">string</span>> { <span class="keywordflow">return</span> fConfig.GetPropertyKeys(); }</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00242"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#abd34c038f5c3c94338419bbd887f3d14"> 242</a></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="l00243"></a><span class="lineno"> 243</span>  {</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  fConfig.Subscribe<T>(subscriber, callback);</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  }</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a1b96fc3f61efccfa5c2048eb578b60e5"> 250</a></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.Unsubscribe<T>(subscriber); }</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div><div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#ad6c37fce55cb631d9f5be45b93a544f9"> 257</a></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="l00258"></a><span class="lineno"> 258</span>  {</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  fConfig.SubscribeAsString(subscriber, callback);</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  }</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00264"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a746aba1505ae9117a28886de85111e16"> 264</a></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.UnsubscribeAsString(subscriber); }</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00267"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a7e4ee07b3e64aca15079165f94ef4580"> 267</a></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="l00269"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a69294d8b0771e3b65d4d4157c4559c52"> 269</a></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="l00271"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a364225377b53067f0bfa1e006fbe069e"> 271</a></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="l00273"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1PluginServices.html#a95095ff2174a531e48d83ee1cfa293d5"> 273</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="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <a class="code" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a>& fConfig;</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <a class="code" href="classFairMQDevice.html">FairMQDevice</a>& fDevice;</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  boost::optional<std::string> fDeviceController;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keyword">mutable</span> std::mutex fDeviceControllerMutex;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  std::condition_variable fReleaseDeviceControlCondition;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> }; <span class="comment">/* class PluginServices */</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PLUGINSERVICES_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:40</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:47</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:250</div></div>
|
|
<div class="ttc" id="classfair_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&#39;t exist) </div><div class="ttdef"><b>Definition:</b> PluginServices.h:166</div></div>
|
|
<div class="ttc" id="classfair_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:173</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:31</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:242</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_aa12e9fe01d4285d31576ef3418098698"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#aa12e9fe01d4285d31576ef3418098698">fair::mq::PluginServices::ToStr</a></div><div class="ttdeci">static auto ToStr(DeviceStateTransition transition) -> std::string</div><div class="ttdoc">Convert DeviceStateTransition to string. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:86</div></div>
|
|
<div class="ttc" id="classfair_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:210</div></div>
|
|
<div class="ttc" id="classfair_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:271</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:142</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:81</div></div>
|
|
<div class="ttc" id="namespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> Error.h:56</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:89</div></div>
|
|
<div class="ttc" id="classfair_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:149</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_a65971490d4b0a9d0a3dfe0303b4c454b"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#a65971490d4b0a9d0a3dfe0303b4c454b">fair::mq::PluginServices::GetProperty</a></div><div class="ttdeci">T GetProperty(const std::string &key, const T &ifNotFound) const</div><div class="ttdoc">Read config property, return provided value if no property with this key exists. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:186</div></div>
|
|
<div class="ttc" id="classfair_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:273</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1PluginServices_1_1DeviceControlError_html"><div class="ttname"><a href="structfair_1_1mq_1_1PluginServices_1_1DeviceControlError.html">fair::mq::PluginServices::DeviceControlError</a></div><div class="ttdef"><b>Definition:</b> PluginServices.h:97</div></div>
|
|
<div class="ttc" id="classfair_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:220</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, throw if no property with this key exists. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:195</div></div>
|
|
<div class="ttc" id="classfair_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:230</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:54</div></div>
|
|
<div class="ttc" id="classfair_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:36</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:133</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1PluginServices_html_acc0aec32c563c0c0db3fd865a3e89f53"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html#acc0aec32c563c0c0db3fd865a3e89f53">fair::mq::PluginServices::GetPropertyAsString</a></div><div class="ttdeci">auto GetPropertyAsString(const std::string &key, const std::string &ifNotFound) const -> std::string</div><div class="ttdoc">Read config property, return provided value if no property with this key exists. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:205</div></div>
|
|
<div class="ttc" id="classfair_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:161</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:70</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, throw if no property with this key exists. </div><div class="ttdef"><b>Definition:</b> PluginServices.h:179</div></div>
|
|
<div class="ttc" id="classfair_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:269</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:257</div></div>
|
|
<div class="ttc" id="classfair_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, leaving property store unchanged) </div><div class="ttdef"><b>Definition:</b> PluginServices.h:169</div></div>
|
|
<div class="ttc" id="classfair_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:226</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:158</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:264</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:76</div></div>
|
|
<div class="ttc" id="classfair_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:267</div></div>
|
|
<div class="ttc" id="classFairMQDevice_html"><div class="ttname"><a href="classFairMQDevice.html">FairMQDevice</a></div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:53</div></div>
|
|
<div class="ttc" id="classfair_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="classfair_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="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</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="classfair_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:216</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:234</div></div>
|
|
<div class="ttc" id="classfair_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><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|