add Doxygen documentation
[o-du/phy.git] / docs / API / u__plane__functional_8cc.html
diff --git a/docs/API/u__plane__functional_8cc.html b/docs/API/u__plane__functional_8cc.html
new file mode 100644 (file)
index 0000000..713dccf
--- /dev/null
@@ -0,0 +1,234 @@
+<!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: u_plane_functional.cc 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><li class="navelem"><a class="el" href="dir_eb25680e5ae075ef825a327f00297047.html">test_xran</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">u_plane_functional.cc File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &quot;<a class="el" href="common_8hpp_source.html">common.hpp</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__up__api_8h_source.html">xran_up_api.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&quot;</code><br />
+<code>#include &quot;<a class="el" href="ethernet_8h_source.html">ethernet.h</a>&quot;</code><br />
+<code>#include &lt;stdint.h&gt;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for u_plane_functional.cc:</div>
+<div class="dyncontent">
+<div class="center"><img src="u__plane__functional_8cc__incl.png" border="0" usemap="#u__plane__functional_8cc" alt=""/></div>
+<map name="u__plane__functional_8cc" id="u__plane__functional_8cc">
+<area shape="rect" id="node2" href="common_8hpp.html" title="common.hpp" alt="" coords="902,80,999,107"/>
+<area shape="rect" id="node27" href="xran__common_8h.html" title="XRAN layer common functionality for both lls&#45;CU and RU as well as C&#45;plane and U&#45;plane. " alt="" coords="1935,80,2049,107"/>
+<area shape="rect" id="node34" href="xran__fh__o__du_8h.html" title="This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN&#45;WG..." alt="" coords="1630,229,1741,256"/>
+<area shape="rect" id="node49" href="xran__up__api_8h.html" title="This file provides the definitions for User Plane Messages APIs. " alt="" coords="2349,80,2451,107"/>
+<area shape="rect" id="node50" href="ethernet_8h.html" title="This file has all definitions for the Ethernet Data Interface Layer. " alt="" coords="1625,80,1705,107"/>
+<area shape="rect" id="node13" href="common__typedef__xran_8h.html" title="This header file defines those data type both used by eNB and UE. " alt="" coords="1029,229,1195,256"/>
+<area shape="rect" id="node17" href="json_8hpp.html" title="json.hpp" alt="" coords="559,155,630,181"/>
+<area shape="rect" id="node45" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="2348,155,2452,181"/>
+<area shape="rect" id="node48" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="1630,155,1733,181"/>
+<area shape="rect" id="node46" href="xran__pkt_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="2372,229,2455,256"/>
+</map>
+</div>
+</div>
+<p><a href="u__plane__functional_8cc_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="class_u__plane_check.html">U_planeCheck</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:a17e5d82ac5aec3860b1324a80fda79ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="u__plane__functional_8cc.html#a17e5d82ac5aec3860b1324a80fda79ed">TEST_P</a> (<a class="el" href="class_u__plane_check.html">U_planeCheck</a>, Test_DLUL)</td></tr>
+<tr class="separator:a17e5d82ac5aec3860b1324a80fda79ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa59dece42a6c30feedc30accb71c2001"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="u__plane__functional_8cc.html#aa59dece42a6c30feedc30accb71c2001">INSTANTIATE_TEST_CASE_P</a> (UnitTest, <a class="el" href="class_u__plane_check.html">U_planeCheck</a>, testing::ValuesIn(<a class="el" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<a class="el" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96">U_planeCheck::get_number_of_cases</a>(&quot;u_plane_functional&quot;))))</td></tr>
+<tr class="separator:aa59dece42a6c30feedc30accb71c2001"><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:a69b4bff6061152ff85770d725cced3cc"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="u__plane__functional_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a> = &quot;u-plane&quot;</td></tr>
+<tr class="separator:a69b4bff6061152ff85770d725cced3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="aa59dece42a6c30feedc30accb71c2001"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa59dece42a6c30feedc30accb71c2001">&#9670;&nbsp;</a></span>INSTANTIATE_TEST_CASE_P()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">INSTANTIATE_TEST_CASE_P </td>
+          <td>(</td>
+          <td class="paramtype">UnitTest&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="class_u__plane_check.html">U_planeCheck</a>&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">testing::ValuesIn(<a class="el" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<a class="el" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96">U_planeCheck::get_number_of_cases</a>(&quot;u_plane_functional&quot;)))&#160;</td>
+          <td class="paramname">&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="u__plane__functional_8cc_aa59dece42a6c30feedc30accb71c2001_icgraph.png" border="0" usemap="#u__plane__functional_8cc_aa59dece42a6c30feedc30accb71c2001_icgraph" alt=""/></div>
+<map name="u__plane__functional_8cc_aa59dece42a6c30feedc30accb71c2001_icgraph" id="u__plane__functional_8cc_aa59dece42a6c30feedc30accb71c2001_icgraph">
+<area shape="rect" id="node2" href="u__plane__functional_8cc.html#a17e5d82ac5aec3860b1324a80fda79ed" title="TEST_P" alt="" coords="264,5,336,32"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a17e5d82ac5aec3860b1324a80fda79ed"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a17e5d82ac5aec3860b1324a80fda79ed">&#9670;&nbsp;</a></span>TEST_P()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TEST_P </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_u__plane_check.html">U_planeCheck</a>&#160;</td>
+          <td class="paramname">, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">Test_DLUL&#160;</td>
+          <td class="paramname">&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="u__plane__functional_8cc_source.html#l00061">61</a> of file <a class="el" href="u__plane__functional_8cc_source.html">u_plane_functional.cc</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="u__plane__functional_8cc_a17e5d82ac5aec3860b1324a80fda79ed_cgraph.png" border="0" usemap="#u__plane__functional_8cc_a17e5d82ac5aec3860b1324a80fda79ed_cgraph" alt=""/></div>
+<map name="u__plane__functional_8cc_a17e5d82ac5aec3860b1324a80fda79ed_cgraph" id="u__plane__functional_8cc_a17e5d82ac5aec3860b1324a80fda79ed_cgraph">
+<area shape="rect" id="node2" href="xran__common_8c.html#adc9636576fb70f4b4fcfd1d03fe59998" title="prepare_symbol_ex" alt="" coords="163,15,298,42"/>
+<area shape="rect" id="node4" href="xran__up__api_8h.html#adfc5ea408600c8de1384be020b359d95" title="Function extracts IQ samples from received mbuf packet. " alt="" coords="147,70,314,97"/>
+<area shape="rect" id="node8" href="u__plane__functional_8cc.html#aa59dece42a6c30feedc30accb71c2001" title="INSTANTIATE_TEST_CASE_P" alt="" coords="125,121,336,147"/>
+<area shape="rect" id="node9" href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5" title="For a given number return sequence of number from 0 to number &#45; 1. " alt="" coords="179,171,282,198"/>
+<area shape="rect" id="node10" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96" title="KernelTests::get_number\l_of_cases" alt="" coords="147,223,315,264"/>
+<area shape="rect" id="node3" href="xran__up__api_8h.html#acd8f547b98d7ebd7dbc41c486a26505d" title="Function for starting preparion of IQ samples portions to be sent in xRAN packet. ..." alt="" coords="384,5,547,47"/>
+<area shape="rect" id="node5" href="xran__transport_8h.html#ab08a85b6527f45a9ba22d25061a96a3c" title="Decompose ecpriRtcid/ecpriPcid. " alt="" coords="393,71,538,98"/>
+<area shape="rect" id="node6" href="xran__common_8h.html#a761e3947dcc547008a12a9cca10b1ea0" title="Get the configuration of eAxC ID. " alt="" coords="595,71,739,98"/>
+<area shape="rect" id="node7" href="xran__main_8c.html#aa09e72e94d2a1d891e86f4c09b0f8b21" title="xran_dev_get_ctx" alt="" coords="787,71,912,98"/>
+<area shape="rect" id="node11" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428" title="Read JSON from the given file. " alt="" coords="398,171,533,198"/>
+<area shape="rect" id="node12" href="classnlohmann_1_1basic__json.html#a0801762a3fe36fe32dca5f16e515478d" title="returns the number of elements " alt="" coords="391,223,539,264"/>
+<area shape="rect" id="node13" href="structmissing__config__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="missing_config_file\l_exception::what" alt="" coords="399,288,532,329"/>
+</map>
+</div>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="a69b4bff6061152ff85770d725cced3cc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a69b4bff6061152ff85770d725cced3cc">&#9670;&nbsp;</a></span>module_name</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const std::string module_name = &quot;u-plane&quot;</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="u__plane__functional_8cc_source.html#l00028">28</a> of file <a class="el" href="u__plane__functional_8cc_source.html">u_plane_functional.cc</a>.</p>
+
+</div>
+</div>
+</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>