mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
90 lines
40 KiB
HTML
90 lines
40 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/ProgOptions.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">ProgOptions.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) 2014-2018 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_PROGOPTIONS_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_PROGOPTIONS_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 "FairMQChannel.h"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "FairMQLogger.h"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <fairmq/EventManager.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <fairmq/ProgOptionsFwd.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <fairmq/Properties.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <fairmq/tools/Strings.h></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <boost/program_options.hpp></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</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 <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <stdexcept></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.html">fair</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> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1PropertyNotFoundError.html"> 34</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1PropertyNotFoundError.html">PropertyNotFoundError</a> : std::runtime_error { <span class="keyword">using</span> std::runtime_error::runtime_error; };</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a>();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</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="keywordtype">void</span> ParseAll(<span class="keyword">const</span> std::vector<std::string>& cmdArgs, <span class="keywordtype">bool</span> allowUnregistered);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> ParseAll(<span class="keyword">const</span> <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> <span class="keyword">const</span>* <span class="keyword">const</span>* argv, <span class="keywordtype">bool</span> allowUnregistered = <span class="keyword">true</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> Notify();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> AddToCmdLineOptions(<span class="keyword">const</span> boost::program_options::options_description optDesc, <span class="keywordtype">bool</span> visible = <span class="keyword">true</span>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  boost::program_options::options_description& GetCmdLineOptions();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">int</span> Count(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::unordered_map<std::string, int> GetChannelInfo() <span class="keyword">const</span>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::vector<std::string> GetPropertyKeys() <span class="keyword">const</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac"> 65</a></span>  T <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a>(<span class="keyword">const</span> std::string& key)<span class="keyword"> const</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">if</span> (fVarMap.count(key)) {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> fVarMap[key].as<T>();</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">throw</span> <a class="code" href="structfair_1_1mq_1_1PropertyNotFoundError.html">PropertyNotFoundError</a>(fair::mq::tools::ToString(<span class="stringliteral">"Config has no key: "</span>, key));</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a4bc1ba359ddeebaa7158d5ebb42ce162"> 80</a></span>  T <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a4bc1ba359ddeebaa7158d5ebb42ce162">GetProperty</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> T& ifNotFound)<span class="keyword"> const</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (fVarMap.count(key)) {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> fVarMap[key].as<T>();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> ifNotFound;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::string GetPropertyAsString(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::string GetPropertyAsString(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> std::string& ifNotFound) <span class="keyword">const</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  fair::mq::Properties GetProperties(<span class="keyword">const</span> std::string& q) <span class="keyword">const</span>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  fair::mq::Properties GetPropertiesStartingWith(<span class="keyword">const</span> std::string& q) <span class="keyword">const</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  std::map<std::string, std::string> GetPropertiesAsString(<span class="keyword">const</span> std::string& q) <span class="keyword">const</span>;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  std::map<std::string, std::string> GetPropertiesAsStringStartingWith(<span class="keyword">const</span> std::string& q) <span class="keyword">const</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c"> 132</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c">SetProperty</a>(<span class="keyword">const</span> std::string& key, T val)</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>  std::unique_lock<std::mutex> lock(fMtx);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  SetVarMapValue<typename std::decay<T>::type>(key, val);</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>  lock.unlock();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  fEvents.Emit<<a class="code" href="structfair_1_1mq_1_1PropertyChange.html">fair::mq::PropertyChange</a>, <span class="keyword">typename</span> std::decay<T>::type>(key, val);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  fEvents.Emit<<a class="code" href="structfair_1_1mq_1_1PropertyChangeAsString.html">fair::mq::PropertyChangeAsString</a>, std::string>(key, GetPropertyAsString(key));</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> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2"> 148</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2">UpdateProperty</a>(<span class="keyword">const</span> std::string& key, T val)</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  {</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  std::unique_lock<std::mutex> lock(fMtx);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">if</span> (fVarMap.count(key)) {</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  SetVarMapValue<typename std::decay<T>::type>(key, val);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  lock.unlock();</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  fEvents.Emit<<a class="code" href="structfair_1_1mq_1_1PropertyChange.html">fair::mq::PropertyChange</a>, <span class="keyword">typename</span> std::decay<T>::type>(key, val);</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  fEvents.Emit<<a class="code" href="structfair_1_1mq_1_1PropertyChangeAsString.html">fair::mq::PropertyChangeAsString</a>, std::string>(key, GetPropertyAsString(key));</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  LOG(debug) << <span class="stringliteral">"UpdateProperty failed, no property found with key '"</span> << key << <span class="stringliteral">"'"</span>;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  }</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">void</span> SetProperties(<span class="keyword">const</span> fair::mq::Properties& input);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">bool</span> UpdateProperties(<span class="keyword">const</span> fair::mq::Properties& input);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">void</span> DeleteProperty(<span class="keyword">const</span> std::string& key);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">void</span> AddChannel(<span class="keyword">const</span> std::string& name, <span class="keyword">const</span> <a class="code" href="classFairMQChannel.html">FairMQChannel</a>& channel);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43"> 187</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43">Subscribe</a>(<span class="keyword">const</span> std::string& subscriber, std::function<<span class="keywordtype">void</span>(<span class="keyword">typename</span> fair::mq::PropertyChange::KeyType, T)> func)<span class="keyword"> const</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  static_assert(!std::is_same<T,const char*>::value || !std::is_same<T, char*>::value,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <span class="stringliteral">"In template member ProgOptions::Subscribe<T>(key,Lambda) the types const char* or char* for the calback signatures are not supported."</span>);</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  fEvents.Subscribe<<a class="code" href="structfair_1_1mq_1_1PropertyChange.html">fair::mq::PropertyChange</a>, T>(subscriber, func);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a"> 198</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a">Unsubscribe</a>(<span class="keyword">const</span> std::string& subscriber)<span class="keyword"> const</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  fEvents.Unsubscribe<<a class="code" href="structfair_1_1mq_1_1PropertyChange.html">fair::mq::PropertyChange</a>, T>(subscriber);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00209"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184"> 209</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184">SubscribeAsString</a>(<span class="keyword">const</span> std::string& subscriber, std::function<<span class="keywordtype">void</span>(<span class="keyword">typename</span> fair::mq::PropertyChange::KeyType, std::string)> func)<span class="keyword"> const</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  fEvents.Subscribe<<a class="code" href="structfair_1_1mq_1_1PropertyChangeAsString.html">fair::mq::PropertyChangeAsString</a>, std::string>(subscriber, func);</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  }</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00217"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae"> 217</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae">UnsubscribeAsString</a>(<span class="keyword">const</span> std::string& subscriber)<span class="keyword"> const</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  fEvents.Unsubscribe<<a class="code" href="structfair_1_1mq_1_1PropertyChangeAsString.html">fair::mq::PropertyChangeAsString</a>, std::string>(subscriber);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  }</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keywordtype">void</span> PrintHelp() <span class="keyword">const</span>;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordtype">void</span> PrintOptions() <span class="keyword">const</span>;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  <span class="keywordtype">void</span> PrintOptionsRaw() <span class="keyword">const</span>;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a2ded0c21581b765a64fd09ac5c52bdce"> 231</a></span>  <span class="keyword">const</span> boost::program_options::variables_map& <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a2ded0c21581b765a64fd09ac5c52bdce">GetVarMap</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> fVarMap; }</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00237"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ProgOptions.html#a5b941eebf2020ad9db2307b2052fbe0f"> 237</a></span>  T <a class="code" href="classfair_1_1mq_1_1ProgOptions.html#a5b941eebf2020ad9db2307b2052fbe0f">GetValue</a>(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span> <span class="comment">/* TODO: deprecate this */</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  {</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  std::lock_guard<std::mutex> lock(fMtx);</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordflow">if</span> (fVarMap.count(key)) {</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordflow">return</span> fVarMap[key].as<T>();</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  LOG(warn) << <span class="stringliteral">"Config has no key: "</span> << key << <span class="stringliteral">". Returning default constructed object."</span>;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keywordflow">return</span> T();</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="l00247"></a><span class="lineno"> 247</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordtype">int</span> SetValue(<span class="keyword">const</span> std::string& key, T val) <span class="comment">/* TODO: deprecate this */</span> { SetProperty(key, val); <span class="keywordflow">return</span> 0; }</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  std::string GetStringValue(<span class="keyword">const</span> std::string& key) <span class="keyword">const</span>; <span class="comment">/* TODO: deprecate this */</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">void</span> ParseDefaults();</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  std::unordered_map<std::string, int> GetChannelInfoImpl() <span class="keyword">const</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>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <span class="keywordtype">void</span> SetVarMapValue(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> T& val)</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>  std::map<std::string, boost::program_options::variable_value>& vm = fVarMap;</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  vm[key].value() = boost::any(val);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  }</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  boost::program_options::variables_map fVarMap; </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  boost::program_options::options_description fAllOptions; </div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  std::vector<std::string> fUnregisteredOptions; </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> </div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="keyword">mutable</span> <a class="code" href="classfair_1_1mq_1_1EventManager.html">fair::mq::EventManager</a> fEvents;</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">mutable</span> std::mutex fMtx;</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> };</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> } <span class="comment">// namespace mq</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> } <span class="comment">// namespace fair</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PROGOPTIONS_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_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:65</div></div>
|
|
<div class="ttc" id="classfair_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:187</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ProgOptions_html_a5b941eebf2020ad9db2307b2052fbe0f"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a5b941eebf2020ad9db2307b2052fbe0f">fair::mq::ProgOptions::GetValue</a></div><div class="ttdeci">T GetValue(const std::string &key) const</div><div class="ttdoc">Read config property, return default-constructed object if key doesn&#39;t exist. </div><div class="ttdef"><b>Definition:</b> ProgOptions.h:237</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ProgOptions_html_a4bc1ba359ddeebaa7158d5ebb42ce162"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a4bc1ba359ddeebaa7158d5ebb42ce162">fair::mq::ProgOptions::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> ProgOptions.h:80</div></div>
|
|
<div class="ttc" id="classfair_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:209</div></div>
|
|
<div class="ttc" id="classfair_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:198</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1EventManager_html"><div class="ttname"><a href="classfair_1_1mq_1_1EventManager.html">fair::mq::EventManager</a></div><div class="ttdoc">Manages event callbacks from different subscribers. </div><div class="ttdef"><b>Definition:</b> EventManager.h:51</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1PropertyNotFoundError_html"><div class="ttname"><a href="structfair_1_1mq_1_1PropertyNotFoundError.html">fair::mq::PropertyNotFoundError</a></div><div class="ttdef"><b>Definition:</b> ProgOptions.h:34</div></div>
|
|
<div class="ttc" id="classFairMQChannel_html"><div class="ttname"><a href="classFairMQChannel.html">FairMQChannel</a></div><div class="ttdef"><b>Definition:</b> FairMQChannel.h:30</div></div>
|
|
<div class="ttc" id="classfair_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&#39;t exist) </div><div class="ttdef"><b>Definition:</b> ProgOptions.h:148</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_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:132</div></div>
|
|
<div class="ttc" id="classfair_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:217</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1PropertyChangeAsString_html"><div class="ttname"><a href="structfair_1_1mq_1_1PropertyChangeAsString.html">fair::mq::PropertyChangeAsString</a></div><div class="ttdef"><b>Definition:</b> Properties.h:33</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_1ProgOptions_html_a2ded0c21581b765a64fd09ac5c52bdce"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#a2ded0c21581b765a64fd09ac5c52bdce">fair::mq::ProgOptions::GetVarMap</a></div><div class="ttdeci">const boost::program_options::variables_map & GetVarMap() const</div><div class="ttdoc">returns the property container </div><div class="ttdef"><b>Definition:</b> ProgOptions.h:231</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1PropertyChange_html"><div class="ttname"><a href="structfair_1_1mq_1_1PropertyChange.html">fair::mq::PropertyChange</a></div><div class="ttdef"><b>Definition:</b> Properties.h:32</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>
|