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
a16e52f809
FairMQ/v1.2.1/classFairProgOptions.html
Dennis Klein 83fa4bb6d9
Add API docs for 1.2.1
2018-05-04 22:17:56 +02:00

168 lines
12 KiB
HTML
Raw 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: FairProgOptions 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.2.1</span>
</div>
<div id="projectbrief">C++ Message Passing 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classFairProgOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairProgOptions Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for FairProgOptions:</div>
<div class="dyncontent">
<div class="center"><img src="classFairProgOptions__inherit__graph.png" border="0" usemap="#FairProgOptions_inherit__map" alt="Inheritance graph"/></div>
<map name="FairProgOptions_inherit__map" id="FairProgOptions_inherit__map">
<area shape="rect" id="node2" href="classFairMQProgOptions.html" title="FairMQProgOptions" alt="" coords="5,80,151,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a91fc0e9e6b7e1972f16126881ecd7f3f"><td class="memItemLeft" align="right" valign="top"><a id="a91fc0e9e6b7e1972f16126881ecd7f3f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetPropertyKeys</b> () const -&gt; std::vector&lt; std::string &gt;</td></tr>
<tr class="separator:a91fc0e9e6b7e1972f16126881ecd7f3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee31b3c969f6e53df61966f6b7a72a9a"><td class="memItemLeft" align="right" valign="top"><a id="aee31b3c969f6e53df61966f6b7a72a9a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairProgOptions.html#aee31b3c969f6e53df61966f6b7a72a9a">AddToCmdLineOptions</a> (const po::options_description optDesc, bool visible=true)</td></tr>
<tr class="memdesc:aee31b3c969f6e53df61966f6b7a72a9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add option descriptions. <br /></td></tr>
<tr class="separator:aee31b3c969f6e53df61966f6b7a72a9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45d385094dc802c3389e22d43cd332f6"><td class="memItemLeft" align="right" valign="top"><a id="a45d385094dc802c3389e22d43cd332f6"></a>
po::options_description &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetCmdLineOptions</b> ()</td></tr>
<tr class="separator:a45d385094dc802c3389e22d43cd332f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a331c5450ad23db3f6e85bb68c815b6f0"><td class="memTemplParams" colspan="2"><a id="a331c5450ad23db3f6e85bb68c815b6f0"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a331c5450ad23db3f6e85bb68c815b6f0"><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:a331c5450ad23db3f6e85bb68c815b6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69a6b6e5b42f6633c6a642804d6ac47d"><td class="memItemLeft" align="right" valign="top"><a id="a69a6b6e5b42f6633c6a642804d6ac47d"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>GetStringValue</b> (const std::string &amp;key)</td></tr>
<tr class="separator:a69a6b6e5b42f6633c6a642804d6ac47d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5088630abb2dddb7d232b8a502f6a41e"><td class="memItemLeft" align="right" valign="top"><a id="a5088630abb2dddb7d232b8a502f6a41e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Count</b> (const std::string &amp;key) const</td></tr>
<tr class="separator:a5088630abb2dddb7d232b8a502f6a41e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a611fe0005b8831f6451aeb5c1acfce1e"><td class="memTemplParams" colspan="2"><a id="a611fe0005b8831f6451aeb5c1acfce1e"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a611fe0005b8831f6451aeb5c1acfce1e"><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:a611fe0005b8831f6451aeb5c1acfce1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b9bbef4d71580ff861ed4c93604efe0"><td class="memItemLeft" align="right" valign="top"><a id="a5b9bbef4d71580ff861ed4c93604efe0"></a>
const po::variables_map &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetVarMap</b> () const</td></tr>
<tr class="separator:a5b9bbef4d71580ff861ed4c93604efe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9ab75c07db52af41fcd746c5f6795aa"><td class="memItemLeft" align="right" valign="top"><a id="ae9ab75c07db52af41fcd746c5f6795aa"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>ParseCmdLine</b> (const int argc, char const *const *argv, bool allowUnregistered=false)</td></tr>
<tr class="separator:ae9ab75c07db52af41fcd746c5f6795aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1556e53de62a9ef797bbebec35aa03e"><td class="memItemLeft" align="right" valign="top"><a id="aa1556e53de62a9ef797bbebec35aa03e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>ParseDefaults</b> ()</td></tr>
<tr class="separator:aa1556e53de62a9ef797bbebec35aa03e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cb6115aeee7e8aac05071a9b0892603"><td class="memItemLeft" align="right" valign="top"><a id="a0cb6115aeee7e8aac05071a9b0892603"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>ParseAll</b> (const int argc, char const *const *argv, bool allowUnregistered=false)=0</td></tr>
<tr class="separator:a0cb6115aeee7e8aac05071a9b0892603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18cbe3e3063de297ccb701b2ed03e8a8"><td class="memItemLeft" align="right" valign="top"><a id="a18cbe3e3063de297ccb701b2ed03e8a8"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>PrintOptions</b> ()</td></tr>
<tr class="separator:a18cbe3e3063de297ccb701b2ed03e8a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a883732ff0ce4fa4fc3d00730683445d2"><td class="memItemLeft" align="right" valign="top"><a id="a883732ff0ce4fa4fc3d00730683445d2"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>PrintOptionsRaw</b> ()</td></tr>
<tr class="separator:a883732ff0ce4fa4fc3d00730683445d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a135d4cc43f4a216a2b78f1dfa55c43a0"><td class="memItemLeft" align="right" valign="top"><a id="a135d4cc43f4a216a2b78f1dfa55c43a0"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><b>ImmediateOptions</b> ()=0</td></tr>
<tr class="separator:a135d4cc43f4a216a2b78f1dfa55c43a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40ab82fdf45696f1d838e584f923dfaa"><td class="memTemplParams" colspan="2"><a id="a40ab82fdf45696f1d838e584f923dfaa"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a40ab82fdf45696f1d838e584f923dfaa"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>UpdateVarMap</b> (const std::string &amp;key, const T &amp;val)</td></tr>
<tr class="separator:a40ab82fdf45696f1d838e584f923dfaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a810a6a804a24d7eb97ab1e2e060c5582"><td class="memTemplParams" colspan="2"><a id="a810a6a804a24d7eb97ab1e2e060c5582"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a810a6a804a24d7eb97ab1e2e060c5582"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Replace</b> (std::map&lt; std::string, po::variable_value &gt; &amp;vm, const std::string &amp;key, const T &amp;val)</td></tr>
<tr class="separator:a810a6a804a24d7eb97ab1e2e060c5582"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a293288ad605f95c14f90fc617da00f63"><td class="memItemLeft" align="right" valign="top"><a id="a293288ad605f95c14f90fc617da00f63"></a>
po::variables_map&#160;</td><td class="memItemRight" valign="bottom"><b>fVarMap</b></td></tr>
<tr class="separator:a293288ad605f95c14f90fc617da00f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abee9fe2ad95c136f52c8c36911dddc42"><td class="memItemLeft" align="right" valign="top"><a id="abee9fe2ad95c136f52c8c36911dddc42"></a>
po::options_description&#160;</td><td class="memItemRight" valign="bottom"><b>fGeneralOptions</b></td></tr>
<tr class="separator:abee9fe2ad95c136f52c8c36911dddc42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1ada8f3c45818bdf8101026e6b093a6"><td class="memItemLeft" align="right" valign="top"><a id="aa1ada8f3c45818bdf8101026e6b093a6"></a>
po::options_description&#160;</td><td class="memItemRight" valign="bottom"><b>fAllOptions</b></td></tr>
<tr class="separator:aa1ada8f3c45818bdf8101026e6b093a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2859a5bf62785895bddfda18ca0f1bc"><td class="memItemLeft" align="right" valign="top"><a id="ae2859a5bf62785895bddfda18ca0f1bc"></a>
std::mutex&#160;</td><td class="memItemRight" valign="bottom"><b>fConfigMutex</b></td></tr>
<tr class="separator:ae2859a5bf62785895bddfda18ca0f1bc"><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="FairProgOptions_8h_source.html">FairProgOptions.h</a></li>
<li>fairmq/options/FairProgOptions.cxx</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink