add Doxygen documentation
[o-du/phy.git] / docs / API / master_8py.html
diff --git a/docs/API/master_8py.html b/docs/API/master_8py.html
new file mode 100644 (file)
index 0000000..d9a446c
--- /dev/null
@@ -0,0 +1,146 @@
+<!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>o-du/phy: master.py File 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">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</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_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_babe8eacf738372576863f88f66866a5.html">test</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#namespaces">Namespaces</a> &#124;
+<a href="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">master.py File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><a href="master_8py_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Data Structures</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmaster_1_1_get_out_of_loops.html">GetOutOfLoops</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
+Namespaces</h2></td></tr>
+<tr class="memitem:namespacemaster"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html">master</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:a04bd95e527992baa27396644b17c76e8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a04bd95e527992baa27396644b17c76e8">init_logger</a> (console_level, logfile_level)</td></tr>
+<tr class="separator:a04bd95e527992baa27396644b17c76e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6ec1b78aa368f25862149fc187d60bfd"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a6ec1b78aa368f25862149fc187d60bfd">parse_args</a> (args)</td></tr>
+<tr class="separator:a6ec1b78aa368f25862149fc187d60bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ada33277f60a7237e56dcc1c27fd0fcc3"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#ada33277f60a7237e56dcc1c27fd0fcc3">is_comment</a> (s)</td></tr>
+<tr class="separator:ada33277f60a7237e56dcc1c27fd0fcc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a132d8e8f29b5cec353381f127ad4c4ae"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a132d8e8f29b5cec353381f127ad4c4ae">compare_resuts</a> (cat, mu, <a class="el" href="gen__test_8m.html#aec71d24b9775c25745c66105ac9371f9">bw</a>, tcase, xran_path, test_cfg, direction)</td></tr>
+<tr class="separator:a132d8e8f29b5cec353381f127ad4c4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a29041cda44c83caed56c5693ae62c878"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a29041cda44c83caed56c5693ae62c878">parse_dat_file</a> (cat, mu, <a class="el" href="gen__test_8m.html#aec71d24b9775c25745c66105ac9371f9">bw</a>, tcase, xran_path, test_cfg)</td></tr>
+<tr class="separator:a29041cda44c83caed56c5693ae62c878"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2730ffb83f627670caa12f7595551151"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a2730ffb83f627670caa12f7595551151">make_copy_mlog</a> (cat, mu, <a class="el" href="gen__test_8m.html#aec71d24b9775c25745c66105ac9371f9">bw</a>, tcase, xran_path)</td></tr>
+<tr class="separator:a2730ffb83f627670caa12f7595551151"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab9aaaee357ffa8fa96b544bd05c1ccb8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#ab9aaaee357ffa8fa96b544bd05c1ccb8">run_tcase</a> (cat, mu, <a class="el" href="gen__test_8m.html#aec71d24b9775c25745c66105ac9371f9">bw</a>, tcase, xran_path)</td></tr>
+<tr class="separator:ab9aaaee357ffa8fa96b544bd05c1ccb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1835cdc0fc647a2c5b5ccf8b5e6e1778"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a1835cdc0fc647a2c5b5ccf8b5e6e1778">main</a> ()</td></tr>
+<tr class="separator:a1835cdc0fc647a2c5b5ccf8b5e6e1778"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<tr class="memitem:abcabfd6caec6142edbd47231f3410f90"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#abcabfd6caec6142edbd47231f3410f90">nNumRbsPerSymF1</a></td></tr>
+<tr class="separator:abcabfd6caec6142edbd47231f3410f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1688f1dc8e00536ec7508a3ad672f85a"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a1688f1dc8e00536ec7508a3ad672f85a">nNumRbsPerSymF2</a></td></tr>
+<tr class="separator:a1688f1dc8e00536ec7508a3ad672f85a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af7850f2256bf3ed75be67d2293f8aa82"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#af7850f2256bf3ed75be67d2293f8aa82">nRChBwOptions_keys</a> = ['5','10','15','20', '25', '30', '40', '50', '60','70', '80', '90', '100', '200', '400']</td></tr>
+<tr class="separator:af7850f2256bf3ed75be67d2293f8aa82"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8d41a616ef51e4a0667d7cde6edc510c"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a8d41a616ef51e4a0667d7cde6edc510c">nRChBwOptions_values</a> = [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14]</td></tr>
+<tr class="separator:a8d41a616ef51e4a0667d7cde6edc510c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ace60ebb76d1266cd70c6b0a2cdb975af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#ace60ebb76d1266cd70c6b0a2cdb975af">nRChBwOptions</a> = dict(zip(nRChBwOptions_keys, nRChBwOptions_values))</td></tr>
+<tr class="separator:ace60ebb76d1266cd70c6b0a2cdb975af"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aed629b78b162e729253b92f7e86074ab"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#aed629b78b162e729253b92f7e86074ab">nRChBwOptions_keys_mu2and3</a> = ['50', '100', '200', '400']</td></tr>
+<tr class="separator:aed629b78b162e729253b92f7e86074ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a60aad357b43b806ac16bfe47e0c8e83c"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a60aad357b43b806ac16bfe47e0c8e83c">nRChBwOptions_values_mu2and3</a> = [0,1,2,3]</td></tr>
+<tr class="separator:a60aad357b43b806ac16bfe47e0c8e83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3594f126fda7271b1a5f0672794af48d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a3594f126fda7271b1a5f0672794af48d">nRChBwOptions_mu2and3</a> = dict(zip(nRChBwOptions_keys_mu2and3, nRChBwOptions_values_mu2and3))</td></tr>
+<tr class="separator:a3594f126fda7271b1a5f0672794af48d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4a9d33bbbfd8552574a68bf5bab018fe"><td class="memItemLeft" align="right" valign="top">list&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a4a9d33bbbfd8552574a68bf5bab018fe">all_test_cases</a></td></tr>
+<tr class="separator:a4a9d33bbbfd8552574a68bf5bab018fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6e1e462cf427d3093cf766e6257db50a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a6e1e462cf427d3093cf766e6257db50a">dic_dir</a> = dict({0:'DL', 1:'UL'})</td></tr>
+<tr class="separator:a6e1e462cf427d3093cf766e6257db50a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0ee1f5720e7776e48e6a82e1d5b78f87"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a0ee1f5720e7776e48e6a82e1d5b78f87">dic_xu</a> = dict({0:'o-du', 1:'o-ru'})</td></tr>
+<tr class="separator:a0ee1f5720e7776e48e6a82e1d5b78f87"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a929ac850002f98328306afef36bad843"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a929ac850002f98328306afef36bad843">START_TIME</a> = datetime.now()</td></tr>
+<tr class="separator:a929ac850002f98328306afef36bad843"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad5c7a065cddc009146ea1b1192eb2102"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#ad5c7a065cddc009146ea1b1192eb2102">res</a> = <a class="el" href="xranlib__unit__test__main_8cc.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a>()</td></tr>
+<tr class="separator:ad5c7a065cddc009146ea1b1192eb2102"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a728d32d8d3a9326d4a888b8bb802cf23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemaster.html#a728d32d8d3a9326d4a888b8bb802cf23">END_TIME</a> = datetime.now()</td></tr>
+<tr class="separator:a728d32d8d3a9326d4a888b8bb802cf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+</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>