mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
965 lines
52 KiB
HTML
965 lines
52 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fair::mq::ProgOptions Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>fair</b></li><li class="navelem"><a class="el" href="namespacefair_1_1mq.html">mq</a></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classfair_1_1mq_1_1ProgOptions-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq::ProgOptions Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad8789107c95b937a2f4a72571cc9173a"><td class="memItemLeft" align="right" valign="top"><a id="ad8789107c95b937a2f4a72571cc9173a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>ParseAll</b> (const std::vector< std::string > &cmdArgs, bool allowUnregistered)</td></tr>
|
|
<tr class="separator:ad8789107c95b937a2f4a72571cc9173a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d4c7e992ea2a6082e05ac291b9d8ec8"><td class="memItemLeft" align="right" valign="top"><a id="a6d4c7e992ea2a6082e05ac291b9d8ec8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>ParseAll</b> (const int argc, char const *const *argv, bool allowUnregistered=true)</td></tr>
|
|
<tr class="separator:a6d4c7e992ea2a6082e05ac291b9d8ec8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a719fc6f0f26cdfcdda388c27a7fe78"><td class="memItemLeft" align="right" valign="top"><a id="a9a719fc6f0f26cdfcdda388c27a7fe78"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Notify</b> ()</td></tr>
|
|
<tr class="separator:a9a719fc6f0f26cdfcdda388c27a7fe78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f7c64de1e5cee362c428d049fd98022"><td class="memItemLeft" align="right" valign="top"><a id="a6f7c64de1e5cee362c428d049fd98022"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>AddToCmdLineOptions</b> (const boost::program_options::options_description optDesc, bool visible=true)</td></tr>
|
|
<tr class="separator:a6f7c64de1e5cee362c428d049fd98022"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada9ef4fb6c3312c300e7d0deef94144d"><td class="memItemLeft" align="right" valign="top"><a id="ada9ef4fb6c3312c300e7d0deef94144d"></a>
|
|
boost::program_options::options_description & </td><td class="memItemRight" valign="bottom"><b>GetCmdLineOptions</b> ()</td></tr>
|
|
<tr class="separator:ada9ef4fb6c3312c300e7d0deef94144d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95494fa84eea46fae7c666f0b82f7048"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a95494fa84eea46fae7c666f0b82f7048">Count</a> (const std::string &key) const</td></tr>
|
|
<tr class="memdesc:a95494fa84eea46fae7c666f0b82f7048"><td class="mdescLeft"> </td><td class="mdescRight">Checks a property with the given key exist in the configuration. <a href="classfair_1_1mq_1_1ProgOptions.html#a95494fa84eea46fae7c666f0b82f7048">More...</a><br /></td></tr>
|
|
<tr class="separator:a95494fa84eea46fae7c666f0b82f7048"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af890f73cfd75cdf5189be7fa936c7bf0"><td class="memItemLeft" align="right" valign="top">std::unordered_map< std::string, int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#af890f73cfd75cdf5189be7fa936c7bf0">GetChannelInfo</a> () const</td></tr>
|
|
<tr class="memdesc:af890f73cfd75cdf5189be7fa936c7bf0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve current channel information. <a href="classfair_1_1mq_1_1ProgOptions.html#af890f73cfd75cdf5189be7fa936c7bf0">More...</a><br /></td></tr>
|
|
<tr class="separator:af890f73cfd75cdf5189be7fa936c7bf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67ef979cc694a245f28084389b8cffc0"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a67ef979cc694a245f28084389b8cffc0">GetPropertyKeys</a> () const</td></tr>
|
|
<tr class="memdesc:a67ef979cc694a245f28084389b8cffc0"><td class="mdescLeft"> </td><td class="mdescRight">Discover the list of property keys. <a href="classfair_1_1mq_1_1ProgOptions.html#a67ef979cc694a245f28084389b8cffc0">More...</a><br /></td></tr>
|
|
<tr class="separator:a67ef979cc694a245f28084389b8cffc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab68955211261d786ddec42aa986484ac"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ab68955211261d786ddec42aa986484ac"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a> (const std::string &key) const</td></tr>
|
|
<tr class="memdesc:ab68955211261d786ddec42aa986484ac"><td class="mdescLeft"> </td><td class="mdescRight">Read config property, throw if no property with this key exists. <a href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">More...</a><br /></td></tr>
|
|
<tr class="separator:ab68955211261d786ddec42aa986484ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bc1ba359ddeebaa7158d5ebb42ce162"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a4bc1ba359ddeebaa7158d5ebb42ce162"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a4bc1ba359ddeebaa7158d5ebb42ce162">GetProperty</a> (const std::string &key, const T &ifNotFound) const</td></tr>
|
|
<tr class="memdesc:a4bc1ba359ddeebaa7158d5ebb42ce162"><td class="mdescLeft"> </td><td class="mdescRight">Read config property, return provided value if no property with this key exists. <a href="classfair_1_1mq_1_1ProgOptions.html#a4bc1ba359ddeebaa7158d5ebb42ce162">More...</a><br /></td></tr>
|
|
<tr class="separator:a4bc1ba359ddeebaa7158d5ebb42ce162"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d0a829555bafa0f19a3f072aa5d0097"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a9d0a829555bafa0f19a3f072aa5d0097">GetPropertyAsString</a> (const std::string &key) const</td></tr>
|
|
<tr class="memdesc:a9d0a829555bafa0f19a3f072aa5d0097"><td class="mdescLeft"> </td><td class="mdescRight">Read config property as string, throw if no property with this key exists. <a href="classfair_1_1mq_1_1ProgOptions.html#a9d0a829555bafa0f19a3f072aa5d0097">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d0a829555bafa0f19a3f072aa5d0097"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad746715d1f7b1e520564967aeb30ffc3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#ad746715d1f7b1e520564967aeb30ffc3">GetPropertyAsString</a> (const std::string &key, const std::string &ifNotFound) const</td></tr>
|
|
<tr class="memdesc:ad746715d1f7b1e520564967aeb30ffc3"><td class="mdescLeft"> </td><td class="mdescRight">Read config property, return provided value if no property with this key exists. <a href="classfair_1_1mq_1_1ProgOptions.html#ad746715d1f7b1e520564967aeb30ffc3">More...</a><br /></td></tr>
|
|
<tr class="separator:ad746715d1f7b1e520564967aeb30ffc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59e98e064e01188e0e52b9ae6f2f83a2"><td class="memItemLeft" align="right" valign="top">fair::mq::Properties </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a59e98e064e01188e0e52b9ae6f2f83a2">GetProperties</a> (const std::string &q) const</td></tr>
|
|
<tr class="memdesc:a59e98e064e01188e0e52b9ae6f2f83a2"><td class="mdescLeft"> </td><td class="mdescRight">Read several config properties whose keys match the provided regular expression. <a href="classfair_1_1mq_1_1ProgOptions.html#a59e98e064e01188e0e52b9ae6f2f83a2">More...</a><br /></td></tr>
|
|
<tr class="separator:a59e98e064e01188e0e52b9ae6f2f83a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69e8c85c5d7778f361244ae554af9f5b"><td class="memItemLeft" align="right" valign="top">fair::mq::Properties </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a69e8c85c5d7778f361244ae554af9f5b">GetPropertiesStartingWith</a> (const std::string &q) const</td></tr>
|
|
<tr class="memdesc:a69e8c85c5d7778f361244ae554af9f5b"><td class="mdescLeft"> </td><td class="mdescRight">Read several config properties whose keys start with the provided string. <a href="classfair_1_1mq_1_1ProgOptions.html#a69e8c85c5d7778f361244ae554af9f5b">More...</a><br /></td></tr>
|
|
<tr class="separator:a69e8c85c5d7778f361244ae554af9f5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcbfe2950b7cf1239cbc7fcf085a8f01"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#abcbfe2950b7cf1239cbc7fcf085a8f01">GetPropertiesAsString</a> (const std::string &q) const</td></tr>
|
|
<tr class="memdesc:abcbfe2950b7cf1239cbc7fcf085a8f01"><td class="mdescLeft"> </td><td class="mdescRight">Read several config properties as string whose keys match the provided regular expression. <a href="classfair_1_1mq_1_1ProgOptions.html#abcbfe2950b7cf1239cbc7fcf085a8f01">More...</a><br /></td></tr>
|
|
<tr class="separator:abcbfe2950b7cf1239cbc7fcf085a8f01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad0d6d0e82c486c9ba09ae5a3e0e4f25"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#aad0d6d0e82c486c9ba09ae5a3e0e4f25">GetPropertiesAsStringStartingWith</a> (const std::string &q) const</td></tr>
|
|
<tr class="memdesc:aad0d6d0e82c486c9ba09ae5a3e0e4f25"><td class="mdescLeft"> </td><td class="mdescRight">Read several config properties as string whose keys start with the provided string. <a href="classfair_1_1mq_1_1ProgOptions.html#aad0d6d0e82c486c9ba09ae5a3e0e4f25">More...</a><br /></td></tr>
|
|
<tr class="separator:aad0d6d0e82c486c9ba09ae5a3e0e4f25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a272f25798b948992a560df32d405517c"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a272f25798b948992a560df32d405517c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c">SetProperty</a> (const std::string &key, T val)</td></tr>
|
|
<tr class="memdesc:a272f25798b948992a560df32d405517c"><td class="mdescLeft"> </td><td class="mdescRight">Set config property. <a href="classfair_1_1mq_1_1ProgOptions.html#a272f25798b948992a560df32d405517c">More...</a><br /></td></tr>
|
|
<tr class="separator:a272f25798b948992a560df32d405517c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a95467b4bdb44c73cf960a60ff0457df2"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a95467b4bdb44c73cf960a60ff0457df2"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2">UpdateProperty</a> (const std::string &key, T val)</td></tr>
|
|
<tr class="memdesc:a95467b4bdb44c73cf960a60ff0457df2"><td class="mdescLeft"> </td><td class="mdescRight">Updates an existing config property (or fails if it doesn't exist) <a href="classfair_1_1mq_1_1ProgOptions.html#a95467b4bdb44c73cf960a60ff0457df2">More...</a><br /></td></tr>
|
|
<tr class="separator:a95467b4bdb44c73cf960a60ff0457df2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9f743fc76dee8566eb843640120e8f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#ae9f743fc76dee8566eb843640120e8f3">SetProperties</a> (const fair::mq::Properties &input)</td></tr>
|
|
<tr class="memdesc:ae9f743fc76dee8566eb843640120e8f3"><td class="mdescLeft"> </td><td class="mdescRight">Set multiple config properties. <a href="classfair_1_1mq_1_1ProgOptions.html#ae9f743fc76dee8566eb843640120e8f3">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9f743fc76dee8566eb843640120e8f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b014a8adcf80aa6fe8b3471e87f13e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a6b014a8adcf80aa6fe8b3471e87f13e6">UpdateProperties</a> (const fair::mq::Properties &input)</td></tr>
|
|
<tr class="memdesc:a6b014a8adcf80aa6fe8b3471e87f13e6"><td class="mdescLeft"> </td><td class="mdescRight">Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged) <a href="classfair_1_1mq_1_1ProgOptions.html#a6b014a8adcf80aa6fe8b3471e87f13e6">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b014a8adcf80aa6fe8b3471e87f13e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e9af05d7ca5f7ac372971a9c7450195"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a8e9af05d7ca5f7ac372971a9c7450195">DeleteProperty</a> (const std::string &key)</td></tr>
|
|
<tr class="memdesc:a8e9af05d7ca5f7ac372971a9c7450195"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a property with the given key from the config store. <a href="classfair_1_1mq_1_1ProgOptions.html#a8e9af05d7ca5f7ac372971a9c7450195">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e9af05d7ca5f7ac372971a9c7450195"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1e7828be92f2bb8419c26e8f5670c8c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#ac1e7828be92f2bb8419c26e8f5670c8c">AddChannel</a> (const std::string &name, const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &channel)</td></tr>
|
|
<tr class="memdesc:ac1e7828be92f2bb8419c26e8f5670c8c"><td class="mdescLeft"> </td><td class="mdescRight">Takes the provided channel and creates properties based on it. <a href="classfair_1_1mq_1_1ProgOptions.html#ac1e7828be92f2bb8419c26e8f5670c8c">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1e7828be92f2bb8419c26e8f5670c8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbf4111312c5cd350dc7b924f8524c43"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:afbf4111312c5cd350dc7b924f8524c43"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43">Subscribe</a> (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, T)> func) const</td></tr>
|
|
<tr class="memdesc:afbf4111312c5cd350dc7b924f8524c43"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to property updates of type T. <a href="classfair_1_1mq_1_1ProgOptions.html#afbf4111312c5cd350dc7b924f8524c43">More...</a><br /></td></tr>
|
|
<tr class="separator:afbf4111312c5cd350dc7b924f8524c43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5afa61b1a9eebb4a9558da3fc8b576a"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:af5afa61b1a9eebb4a9558da3fc8b576a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a">Unsubscribe</a> (const std::string &subscriber) const</td></tr>
|
|
<tr class="memdesc:af5afa61b1a9eebb4a9558da3fc8b576a"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe from property updates of type T. <a href="classfair_1_1mq_1_1ProgOptions.html#af5afa61b1a9eebb4a9558da3fc8b576a">More...</a><br /></td></tr>
|
|
<tr class="separator:af5afa61b1a9eebb4a9558da3fc8b576a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3de4a0e1a29cdeccd54e67da544ab184"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184">SubscribeAsString</a> (const std::string &subscriber, std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> func) const</td></tr>
|
|
<tr class="memdesc:a3de4a0e1a29cdeccd54e67da544ab184"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to property updates, with values converted to string. <a href="classfair_1_1mq_1_1ProgOptions.html#a3de4a0e1a29cdeccd54e67da544ab184">More...</a><br /></td></tr>
|
|
<tr class="separator:a3de4a0e1a29cdeccd54e67da544ab184"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5a595dbee8a9331d33e0cd3eaefb4ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae">UnsubscribeAsString</a> (const std::string &subscriber) const</td></tr>
|
|
<tr class="memdesc:af5a595dbee8a9331d33e0cd3eaefb4ae"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe from property updates that convert to string. <a href="classfair_1_1mq_1_1ProgOptions.html#af5a595dbee8a9331d33e0cd3eaefb4ae">More...</a><br /></td></tr>
|
|
<tr class="separator:af5a595dbee8a9331d33e0cd3eaefb4ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96cf8720fd0dff3f4470973cccb9cb3b"><td class="memItemLeft" align="right" valign="top"><a id="a96cf8720fd0dff3f4470973cccb9cb3b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a96cf8720fd0dff3f4470973cccb9cb3b">PrintHelp</a> () const</td></tr>
|
|
<tr class="memdesc:a96cf8720fd0dff3f4470973cccb9cb3b"><td class="mdescLeft"> </td><td class="mdescRight">prints full options description <br /></td></tr>
|
|
<tr class="separator:a96cf8720fd0dff3f4470973cccb9cb3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bbba3bdd59e4a928602999635a09db7"><td class="memItemLeft" align="right" valign="top"><a id="a1bbba3bdd59e4a928602999635a09db7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a1bbba3bdd59e4a928602999635a09db7">PrintOptions</a> () const</td></tr>
|
|
<tr class="memdesc:a1bbba3bdd59e4a928602999635a09db7"><td class="mdescLeft"> </td><td class="mdescRight">prints properties stored in the property container <br /></td></tr>
|
|
<tr class="separator:a1bbba3bdd59e4a928602999635a09db7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72b6fe74ff97eb4c318dd53791143a02"><td class="memItemLeft" align="right" valign="top"><a id="a72b6fe74ff97eb4c318dd53791143a02"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a72b6fe74ff97eb4c318dd53791143a02">PrintOptionsRaw</a> () const</td></tr>
|
|
<tr class="memdesc:a72b6fe74ff97eb4c318dd53791143a02"><td class="mdescLeft"> </td><td class="mdescRight">prints full options description in a compact machine-readable format <br /></td></tr>
|
|
<tr class="separator:a72b6fe74ff97eb4c318dd53791143a02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ded0c21581b765a64fd09ac5c52bdce"><td class="memItemLeft" align="right" valign="top"><a id="a2ded0c21581b765a64fd09ac5c52bdce"></a>
|
|
const boost::program_options::variables_map & </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a2ded0c21581b765a64fd09ac5c52bdce">GetVarMap</a> () const</td></tr>
|
|
<tr class="memdesc:a2ded0c21581b765a64fd09ac5c52bdce"><td class="mdescLeft"> </td><td class="mdescRight">returns the property container <br /></td></tr>
|
|
<tr class="separator:a2ded0c21581b765a64fd09ac5c52bdce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b941eebf2020ad9db2307b2052fbe0f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a5b941eebf2020ad9db2307b2052fbe0f"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a5b941eebf2020ad9db2307b2052fbe0f">GetValue</a> (const std::string &key) const</td></tr>
|
|
<tr class="memdesc:a5b941eebf2020ad9db2307b2052fbe0f"><td class="mdescLeft"> </td><td class="mdescRight">Read config property, return default-constructed object if key doesn't exist. <a href="classfair_1_1mq_1_1ProgOptions.html#a5b941eebf2020ad9db2307b2052fbe0f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b941eebf2020ad9db2307b2052fbe0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca558d2c8c846f9e0bbe25d5ec1a55ab"><td class="memTemplParams" colspan="2"><a id="aca558d2c8c846f9e0bbe25d5ec1a55ab"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:aca558d2c8c846f9e0bbe25d5ec1a55ab"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><b>SetValue</b> (const std::string &key, T val)</td></tr>
|
|
<tr class="separator:aca558d2c8c846f9e0bbe25d5ec1a55ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a83424f7420f8d1ddab01fb85f07221"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ProgOptions.html#a2a83424f7420f8d1ddab01fb85f07221">GetStringValue</a> (const std::string &key) const</td></tr>
|
|
<tr class="memdesc:a2a83424f7420f8d1ddab01fb85f07221"><td class="mdescLeft"> </td><td class="mdescRight">Read config property as string, return default-constructed object if key doesn't exist. <a href="classfair_1_1mq_1_1ProgOptions.html#a2a83424f7420f8d1ddab01fb85f07221">More...</a><br /></td></tr>
|
|
<tr class="separator:a2a83424f7420f8d1ddab01fb85f07221"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac1e7828be92f2bb8419c26e8f5670c8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1e7828be92f2bb8419c26e8f5670c8c">◆ </a></span>AddChannel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::AddChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td>
|
|
<td class="paramname"><em>channel</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Takes the provided channel and creates properties based on it. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">channel</td><td><a class="el" href="classFairMQChannel.html" title="Wrapper class for FairMQSocket and related methods.">FairMQChannel</a> reference </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95494fa84eea46fae7c666f0b82f7048"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95494fa84eea46fae7c666f0b82f7048">◆ </a></span>Count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int fair::mq::ProgOptions::Count </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks a property with the given key exist in the configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if it exists, 0 otherwise </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e9af05d7ca5f7ac372971a9c7450195"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e9af05d7ca5f7ac372971a9c7450195">◆ </a></span>DeleteProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::DeleteProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes a property with the given key from the config store. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af890f73cfd75cdf5189be7fa936c7bf0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af890f73cfd75cdf5189be7fa936c7bf0">◆ </a></span>GetChannelInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unordered_map< string, int > fair::mq::ProgOptions::GetChannelInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieve current channel information. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>a map of <channel name, number of subchannels> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59e98e064e01188e0e52b9ae6f2f83a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59e98e064e01188e0e52b9ae6f2f83a2">◆ </a></span>GetProperties()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Properties fair::mq::ProgOptions::GetProperties </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read several config properties whose keys match the provided regular expression. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q</td><td>regex string to match for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abcbfe2950b7cf1239cbc7fcf085a8f01"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abcbfe2950b7cf1239cbc7fcf085a8f01">◆ </a></span>GetPropertiesAsString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">map< string, string > fair::mq::ProgOptions::GetPropertiesAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read several config properties as string whose keys match the provided regular expression. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q</td><td>regex string to match for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad0d6d0e82c486c9ba09ae5a3e0e4f25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad0d6d0e82c486c9ba09ae5a3e0e4f25">◆ </a></span>GetPropertiesAsStringStartingWith()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">map< string, string > fair::mq::ProgOptions::GetPropertiesAsStringStartingWith </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read several config properties as string whose keys start with the provided string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q</td><td>string to match for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any)</dd></dl>
|
|
<p>Typically more performant than GetPropertiesAsString with regex </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69e8c85c5d7778f361244ae554af9f5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69e8c85c5d7778f361244ae554af9f5b">◆ </a></span>GetPropertiesStartingWith()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Properties fair::mq::ProgOptions::GetPropertiesStartingWith </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>q</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read several config properties whose keys start with the provided string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">q</td><td>string to match for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>container with properties (fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any)</dd></dl>
|
|
<p>Typically more performant than GetProperties with regex </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab68955211261d786ddec42aa986484ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab68955211261d786ddec42aa986484ac">◆ </a></span>GetProperty() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T fair::mq::ProgOptions::GetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property, throw if no property with this key exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bc1ba359ddeebaa7158d5ebb42ce162"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bc1ba359ddeebaa7158d5ebb42ce162">◆ </a></span>GetProperty() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T fair::mq::ProgOptions::GetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T & </td>
|
|
<td class="paramname"><em>ifNotFound</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property, return provided value if no property with this key exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
<tr><td class="paramname">ifNotFound</td><td>value to return if key is not found </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d0a829555bafa0f19a3f072aa5d0097"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d0a829555bafa0f19a3f072aa5d0097">◆ </a></span>GetPropertyAsString() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fair::mq::ProgOptions::GetPropertyAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property as string, throw if no property with this key exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property converted to string</dd></dl>
|
|
<p>Supports conversion to string for a fixed set of types, for custom/unsupported types add them via <code>fair::mq::PropertyHelper::AddType<MyType>("optional label")</code> the provided type must then be convertible to string via operator<< </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad746715d1f7b1e520564967aeb30ffc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad746715d1f7b1e520564967aeb30ffc3">◆ </a></span>GetPropertyAsString() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string fair::mq::ProgOptions::GetPropertyAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>ifNotFound</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property, return provided value if no property with this key exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
<tr><td class="paramname">ifNotFound</td><td>value to return if key is not found </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property converted to string</dd></dl>
|
|
<p>Supports conversion to string for a fixed set of types, for custom/unsupported types add them via <code>fair::mq::PropertyHelper::AddType<MyType>("optional label")</code> the provided type must then be convertible to string via operator<< </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a67ef979cc694a245f28084389b8cffc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a67ef979cc694a245f28084389b8cffc0">◆ </a></span>GetPropertyKeys()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">vector< string > fair::mq::ProgOptions::GetPropertyKeys </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Discover the list of property keys. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>list of property keys </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a83424f7420f8d1ddab01fb85f07221"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a83424f7420f8d1ddab01fb85f07221">◆ </a></span>GetStringValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string fair::mq::ProgOptions::GetStringValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property as string, return default-constructed object if key doesn't exist. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b941eebf2020ad9db2307b2052fbe0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b941eebf2020ad9db2307b2052fbe0f">◆ </a></span>GetValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T fair::mq::ProgOptions::GetValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read config property, return default-constructed object if key doesn't exist. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>config property </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae9f743fc76dee8566eb843640120e8f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae9f743fc76dee8566eb843640120e8f3">◆ </a></span>SetProperties()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::SetProperties </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fair::mq::Properties & </td>
|
|
<td class="paramname"><em>input</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set multiple config properties. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">props</td><td>fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a272f25798b948992a560df32d405517c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a272f25798b948992a560df32d405517c">◆ </a></span>SetProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::SetProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set config property. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
<tr><td class="paramname">val</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbf4111312c5cd350dc7b924f8524c43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbf4111312c5cd350dc7b924f8524c43">◆ </a></span>Subscribe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::Subscribe </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>subscriber</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(typename fair::mq::PropertyChange::KeyType, T)> </td>
|
|
<td class="paramname"><em>func</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Subscribe to property updates of type T. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">subscriber</td><td></td></tr>
|
|
<tr><td class="paramname">callback</td><td>function</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Subscribe to property changes with a callback to monitor property changes in an event based fashion. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3de4a0e1a29cdeccd54e67da544ab184"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3de4a0e1a29cdeccd54e67da544ab184">◆ </a></span>SubscribeAsString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::SubscribeAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>subscriber</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(typename fair::mq::PropertyChange::KeyType, std::string)> </td>
|
|
<td class="paramname"><em>func</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Subscribe to property updates, with values converted to string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">subscriber</td><td></td></tr>
|
|
<tr><td class="paramname">callback</td><td>function</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Subscribe to property changes with a callback to monitor property changes in an event based fashion. Will convert the property to string. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5afa61b1a9eebb4a9558da3fc8b576a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5afa61b1a9eebb4a9558da3fc8b576a">◆ </a></span>Unsubscribe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::Unsubscribe </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>subscriber</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsubscribe from property updates of type T. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">subscriber</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5a595dbee8a9331d33e0cd3eaefb4ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5a595dbee8a9331d33e0cd3eaefb4ae">◆ </a></span>UnsubscribeAsString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void fair::mq::ProgOptions::UnsubscribeAsString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>subscriber</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsubscribe from property updates that convert to string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">subscriber</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b014a8adcf80aa6fe8b3471e87f13e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b014a8adcf80aa6fe8b3471e87f13e6">◆ </a></span>UpdateProperties()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fair::mq::ProgOptions::UpdateProperties </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fair::mq::Properties & </td>
|
|
<td class="paramname"><em>input</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates multiple existing config properties (or fails of any of then do not exist, leaving property store unchanged) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">props</td><td>(fair::mq::Properties as an alias for std::map<std::string, Property>, where property is boost::any) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a95467b4bdb44c73cf960a60ff0457df2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a95467b4bdb44c73cf960a60ff0457df2">◆ </a></span>UpdateProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool fair::mq::ProgOptions::UpdateProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates an existing config property (or fails if it doesn't exist) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td></td></tr>
|
|
<tr><td class="paramname">val</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/<a class="el" href="ProgOptions_8h_source.html">ProgOptions.h</a></li>
|
|
<li>fairmq/ProgOptions.cxx</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|