Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 08:41:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.3.8/classFairMQProgOptions.html
Dennis Klein f1c3c5f6c4
Add API docs for 1.3.8
2019-01-07 13:13:30 +01:00

150 lines
12 KiB
HTML
Raw Permalink Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: FairMQProgOptions 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
&#160;<span id="projectnumber">1.3.8</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classFairMQProgOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairMQProgOptions 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:a7ed05fbb030aabdd45732edfbb98fb6c"><td class="memItemLeft" align="right" valign="top"><a id="a7ed05fbb030aabdd45732edfbb98fb6c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ParseAll</b> (const std::vector&lt; std::string &gt; &amp;cmdLineArgs, bool allowUnregistered)</td></tr>
<tr class="separator:a7ed05fbb030aabdd45732edfbb98fb6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b17a2eb910e198cab18592d898a986f"><td class="memItemLeft" align="right" valign="top"><a id="a2b17a2eb910e198cab18592d898a986f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ParseAll</b> (const int argc, char const *const *argv, bool allowUnregistered=true)</td></tr>
<tr class="separator:a2b17a2eb910e198cab18592d898a986f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72d53071d72ff43784948ee779b651c9"><td class="memItemLeft" align="right" valign="top"><a id="a72d53071d72ff43784948ee779b651c9"></a>
FairMQChannelMap&#160;</td><td class="memItemRight" valign="bottom"><b>GetFairMQMap</b> () const</td></tr>
<tr class="separator:a72d53071d72ff43784948ee779b651c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8a34267bbac4b3bbb3616a76ea76814"><td class="memItemLeft" align="right" valign="top"><a id="ad8a34267bbac4b3bbb3616a76ea76814"></a>
std::unordered_map&lt; std::string, int &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetChannelInfo</b> () const</td></tr>
<tr class="separator:ad8a34267bbac4b3bbb3616a76ea76814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeab38fcab838cea5c92d0cb2239220c8"><td class="memTemplParams" colspan="2"><a id="aeab38fcab838cea5c92d0cb2239220c8"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:aeab38fcab838cea5c92d0cb2239220c8"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><b>SetValue</b> (const std::string &amp;key, T val)</td></tr>
<tr class="separator:aeab38fcab838cea5c92d0cb2239220c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1fabed6b4980a065b43902c0bc5a90d"><td class="memTemplParams" colspan="2"><a id="ac1fabed6b4980a065b43902c0bc5a90d"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac1fabed6b4980a065b43902c0bc5a90d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Subscribe</b> (const std::string &amp;subscriber, std::function&lt; void(typename fair::mq::PropertyChange::KeyType, T)&gt; func)</td></tr>
<tr class="separator:ac1fabed6b4980a065b43902c0bc5a90d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4d5db2e445fd4557d1f6cf5e0af1470"><td class="memTemplParams" colspan="2"><a id="aa4d5db2e445fd4557d1f6cf5e0af1470"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:aa4d5db2e445fd4557d1f6cf5e0af1470"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Unsubscribe</b> (const std::string &amp;subscriber)</td></tr>
<tr class="separator:aa4d5db2e445fd4557d1f6cf5e0af1470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c40b3375b23a3ed138c27bf39c07cdd"><td class="memItemLeft" align="right" valign="top"><a id="a7c40b3375b23a3ed138c27bf39c07cdd"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SubscribeAsString</b> (const std::string &amp;subscriber, std::function&lt; void(typename fair::mq::PropertyChange::KeyType, std::string)&gt; func)</td></tr>
<tr class="separator:a7c40b3375b23a3ed138c27bf39c07cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab891f43e35f5402dd28b7e9be445bac2"><td class="memItemLeft" align="right" valign="top"><a id="ab891f43e35f5402dd28b7e9be445bac2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>UnsubscribeAsString</b> (const std::string &amp;subscriber)</td></tr>
<tr class="separator:ab891f43e35f5402dd28b7e9be445bac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41858ac74fdbbe8a47e06ebc4a58cbc2"><td class="memItemLeft" align="right" valign="top"><a id="a41858ac74fdbbe8a47e06ebc4a58cbc2"></a>
std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetPropertyKeys</b> () const</td></tr>
<tr class="separator:a41858ac74fdbbe8a47e06ebc4a58cbc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0e8dd8712ff457e4d71700f4d6a926e"><td class="memTemplParams" colspan="2"><a id="ab0e8dd8712ff457e4d71700f4d6a926e"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:ab0e8dd8712ff457e4d71700f4d6a926e"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>GetValue</b> (const std::string &amp;key) const</td></tr>
<tr class="separator:ab0e8dd8712ff457e4d71700f4d6a926e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af37848d7a2235958d1b0e393601c5721"><td class="memItemLeft" align="right" valign="top"><a id="af37848d7a2235958d1b0e393601c5721"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetStringValue</b> (const std::string &amp;key)</td></tr>
<tr class="separator:af37848d7a2235958d1b0e393601c5721"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9fce97e0d829051a400856938f6f826"><td class="memItemLeft" align="right" valign="top"><a id="ae9fce97e0d829051a400856938f6f826"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Count</b> (const std::string &amp;key) const</td></tr>
<tr class="separator:ae9fce97e0d829051a400856938f6f826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade220492319e06b628bd5d418adbd80c"><td class="memTemplParams" colspan="2"><a id="ade220492319e06b628bd5d418adbd80c"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:ade220492319e06b628bd5d418adbd80c"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>ConvertTo</b> (const std::string &amp;strValue)</td></tr>
<tr class="separator:ade220492319e06b628bd5d418adbd80c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb7c568283f0d2d7d21471be55b301e0"><td class="memItemLeft" align="right" valign="top"><a id="acb7c568283f0d2d7d21471be55b301e0"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQProgOptions.html#acb7c568283f0d2d7d21471be55b301e0">AddToCmdLineOptions</a> (const boost::program_options::options_description optDesc, bool visible=true)</td></tr>
<tr class="memdesc:acb7c568283f0d2d7d21471be55b301e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add option descriptions. <br /></td></tr>
<tr class="separator:acb7c568283f0d2d7d21471be55b301e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8838b15664cfe870209e405fc195aaa6"><td class="memItemLeft" align="right" valign="top"><a id="a8838b15664cfe870209e405fc195aaa6"></a>
boost::program_options::options_description &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetCmdLineOptions</b> ()</td></tr>
<tr class="separator:a8838b15664cfe870209e405fc195aaa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca7e19ae768fb2324a995282a1970dc0"><td class="memItemLeft" align="right" valign="top"><a id="aca7e19ae768fb2324a995282a1970dc0"></a>
const boost::program_options::variables_map &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetVarMap</b> () const</td></tr>
<tr class="separator:aca7e19ae768fb2324a995282a1970dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a028cb5303fee700bdf33a1597675a3c5"><td class="memItemLeft" align="right" valign="top"><a id="a028cb5303fee700bdf33a1597675a3c5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>PrintOptions</b> ()</td></tr>
<tr class="separator:a028cb5303fee700bdf33a1597675a3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2439305ea908cd751ea15737df0c88b"><td class="memItemLeft" align="right" valign="top"><a id="ac2439305ea908cd751ea15737df0c88b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>PrintOptionsRaw</b> ()</td></tr>
<tr class="separator:ac2439305ea908cd751ea15737df0c88b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb02dfe65fd661587a4b024e6bafd907"><td class="memItemLeft" align="right" valign="top"><a id="aeb02dfe65fd661587a4b024e6bafd907"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>AddChannel</b> (const std::string &amp;channelName, const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &amp;channel)</td></tr>
<tr class="separator:aeb02dfe65fd661587a4b024e6bafd907"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/options/<a class="el" href="FairMQProgOptions_8h_source.html">FairMQProgOptions.h</a></li>
<li>fairmq/options/FairMQProgOptions.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>
Reference in New Issue View Git Blame Copy Permalink