add Doxygen documentation
[o-du/phy.git] / docs / API / u__plane__performance_8cc.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: u_plane_performance.cc File Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 <div id="nav-path" class="navpath">
61   <ul>
62 <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>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="summary">
67 <a href="#nested-classes">Data Structures</a> &#124;
68 <a href="#func-members">Functions</a> &#124;
69 <a href="#var-members">Variables</a>  </div>
70   <div class="headertitle">
71 <div class="title">u_plane_performance.cc File Reference</div>  </div>
72 </div><!--header-->
73 <div class="contents">
74 <div class="textblock"><code>#include &quot;<a class="el" href="common_8hpp_source.html">common.hpp</a>&quot;</code><br />
75 <code>#include &quot;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&quot;</code><br />
76 <code>#include &quot;<a class="el" href="xran__fh__o__du_8h_source.html">xran_fh_o_du.h</a>&quot;</code><br />
77 <code>#include &quot;<a class="el" href="ethernet_8h_source.html">ethernet.h</a>&quot;</code><br />
78 <code>#include &lt;stdint.h&gt;</code><br />
79 </div><div class="textblock"><div class="dynheader">
80 Include dependency graph for u_plane_performance.cc:</div>
81 <div class="dyncontent">
82 <div class="center"><img src="u__plane__performance_8cc__incl.png" border="0" usemap="#u__plane__performance_8cc" alt=""/></div>
83 <map name="u__plane__performance_8cc" id="u__plane__performance_8cc">
84 <area shape="rect" id="node2" href="common_8hpp.html" title="common.hpp" alt="" coords="889,80,986,107"/>
85 <area shape="rect" id="node29" 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="1999,80,2113,107"/>
86 <area shape="rect" id="node36" 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="2195,229,2306,256"/>
87 <area shape="rect" id="node49" href="ethernet_8h.html" title="This file has all definitions for the Ethernet Data Interface Layer. " alt="" coords="1489,80,1569,107"/>
88 <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="1405,229,1571,256"/>
89 <area shape="rect" id="node17" href="json_8hpp.html" title="json.hpp" alt="" coords="539,155,610,181"/>
90 <area shape="rect" id="node47" href="xran__pkt__up_8h.html" title="Definitions and support functions to process XRAN packet. " alt="" coords="1915,155,2019,181"/>
91 <area shape="rect" id="node48" href="xran__cp__api_8h.html" title="This file provides the definitions for Control Plane Messages APIs. " alt="" coords="2195,155,2298,181"/>
92 </map>
93 </div>
94 </div>
95 <p><a href="u__plane__performance_8cc_source.html">Go to the source code of this file.</a></p>
96 <table class="memberdecls">
97 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
98 Data Structures</h2></td></tr>
99 <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_perf.html">U_planePerf</a></td></tr>
100 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 </table><table class="memberdecls">
102 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
103 Functions</h2></td></tr>
104 <tr class="memitem:a227817e595c0b079e12728d4d19364e8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="u__plane__performance_8cc.html#a227817e595c0b079e12728d4d19364e8">TEST_P</a> (<a class="el" href="class_u__plane_perf.html">U_planePerf</a>, Test_DL)</td></tr>
105 <tr class="separator:a227817e595c0b079e12728d4d19364e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
106 <tr class="memitem:ac3ee52d20c26760f73891becf45f317b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="u__plane__performance_8cc.html#ac3ee52d20c26760f73891becf45f317b">INSTANTIATE_TEST_CASE_P</a> (UnitTest, <a class="el" href="class_u__plane_perf.html">U_planePerf</a>, testing::ValuesIn(<a class="el" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a>(<a class="el" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96">U_planePerf::get_number_of_cases</a>(&quot;u_plane_performance&quot;))))</td></tr>
107 <tr class="separator:ac3ee52d20c26760f73891becf45f317b"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 </table><table class="memberdecls">
109 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
110 Variables</h2></td></tr>
111 <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__performance_8cc.html#a69b4bff6061152ff85770d725cced3cc">module_name</a> = &quot;u-plane&quot;</td></tr>
112 <tr class="separator:a69b4bff6061152ff85770d725cced3cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 </table>
114 <h2 class="groupheader">Function Documentation</h2>
115 <a id="ac3ee52d20c26760f73891becf45f317b"></a>
116 <h2 class="memtitle"><span class="permalink"><a href="#ac3ee52d20c26760f73891becf45f317b">&#9670;&nbsp;</a></span>INSTANTIATE_TEST_CASE_P()</h2>
117
118 <div class="memitem">
119 <div class="memproto">
120       <table class="memname">
121         <tr>
122           <td class="memname">INSTANTIATE_TEST_CASE_P </td>
123           <td>(</td>
124           <td class="paramtype">UnitTest&#160;</td>
125           <td class="paramname">, </td>
126         </tr>
127         <tr>
128           <td class="paramkey"></td>
129           <td></td>
130           <td class="paramtype"><a class="el" href="class_u__plane_perf.html">U_planePerf</a>&#160;</td>
131           <td class="paramname">, </td>
132         </tr>
133         <tr>
134           <td class="paramkey"></td>
135           <td></td>
136           <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_planePerf::get_number_of_cases</a>(&quot;u_plane_performance&quot;)))&#160;</td>
137           <td class="paramname">&#160;</td>
138         </tr>
139         <tr>
140           <td></td>
141           <td>)</td>
142           <td></td><td></td>
143         </tr>
144       </table>
145 </div><div class="memdoc">
146 <div class="dynheader">
147 Here is the caller graph for this function:</div>
148 <div class="dyncontent">
149 <div class="center"><img src="u__plane__performance_8cc_ac3ee52d20c26760f73891becf45f317b_icgraph.png" border="0" usemap="#u__plane__performance_8cc_ac3ee52d20c26760f73891becf45f317b_icgraph" alt=""/></div>
150 <map name="u__plane__performance_8cc_ac3ee52d20c26760f73891becf45f317b_icgraph" id="u__plane__performance_8cc_ac3ee52d20c26760f73891becf45f317b_icgraph">
151 <area shape="rect" id="node2" href="u__plane__performance_8cc.html#a227817e595c0b079e12728d4d19364e8" title="TEST_P" alt="" coords="264,5,336,32"/>
152 </map>
153 </div>
154
155 </div>
156 </div>
157 <a id="a227817e595c0b079e12728d4d19364e8"></a>
158 <h2 class="memtitle"><span class="permalink"><a href="#a227817e595c0b079e12728d4d19364e8">&#9670;&nbsp;</a></span>TEST_P()</h2>
159
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname">TEST_P </td>
165           <td>(</td>
166           <td class="paramtype"><a class="el" href="class_u__plane_perf.html">U_planePerf</a>&#160;</td>
167           <td class="paramname">, </td>
168         </tr>
169         <tr>
170           <td class="paramkey"></td>
171           <td></td>
172           <td class="paramtype">Test_DL&#160;</td>
173           <td class="paramname">&#160;</td>
174         </tr>
175         <tr>
176           <td></td>
177           <td>)</td>
178           <td></td><td></td>
179         </tr>
180       </table>
181 </div><div class="memdoc">
182
183 <p class="definition">Definition at line <a class="el" href="u__plane__performance_8cc_source.html#l00104">104</a> of file <a class="el" href="u__plane__performance_8cc_source.html">u_plane_performance.cc</a>.</p>
184 <div class="dynheader">
185 Here is the call graph for this function:</div>
186 <div class="dyncontent">
187 <div class="center"><img src="u__plane__performance_8cc_a227817e595c0b079e12728d4d19364e8_cgraph.png" border="0" usemap="#u__plane__performance_8cc_a227817e595c0b079e12728d4d19364e8_cgraph" alt=""/></div>
188 <map name="u__plane__performance_8cc_a227817e595c0b079e12728d4d19364e8_cgraph" id="u__plane__performance_8cc_a227817e595c0b079e12728d4d19364e8_cgraph">
189 <area shape="rect" id="node2" href="class_kernel_tests.html#a3cf2e25a99be565a4ab570737cfeac41" title="Run performance test case for a given function. " alt="" coords="145,56,317,83"/>
190 <area shape="rect" id="node6" href="class_u__plane_perf.html#aa2fb15367f40188e0a2d2c15fa6ad124" title="U_planePerf::fucntional_dl" alt="" coords="143,111,318,137"/>
191 <area shape="rect" id="node9" href="u__plane__performance_8cc.html#ac3ee52d20c26760f73891becf45f317b" title="INSTANTIATE_TEST_CASE_P" alt="" coords="125,161,336,188"/>
192 <area shape="rect" id="node10" href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5" title="For a given number return sequence of number from 0 to number &#45; 1. " alt="" coords="179,212,282,239"/>
193 <area shape="rect" id="node11" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96" title="KernelTests::get_number\l_of_cases" alt="" coords="147,263,315,305"/>
194 <area shape="rect" id="node3" href="common_8hpp.html#ae39390f41ba978a1f0d79691436c074a" title="Attach current process to the selected core. " alt="" coords="412,5,504,32"/>
195 <area shape="rect" id="node4" href="common_8hpp.html#af69d779517f2bdee3aba95bc38022074" title="Run the given function and return the mean run time and stddev. " alt="" coords="403,56,513,83"/>
196 <area shape="rect" id="node5" href="common_8hpp.html#a8265b710246f9019ff14556adf5eb35a" title="Calculate the mean and variance from the result of the run_benchmark. " alt="" coords="594,55,729,81"/>
197 <area shape="rect" id="node7" href="xran__common_8c.html#adc9636576fb70f4b4fcfd1d03fe59998" title="prepare_symbol_ex" alt="" coords="391,112,525,139"/>
198 <area shape="rect" id="node8" href="xran__up__api_8h.html#acd8f547b98d7ebd7dbc41c486a26505d" title="Function for starting preparion of IQ samples portions to be sent in xRAN packet. ..." alt="" coords="580,106,743,147"/>
199 <area shape="rect" id="node12" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428" title="Read JSON from the given file. " alt="" coords="391,212,525,239"/>
200 <area shape="rect" id="node13" href="classnlohmann_1_1basic__json.html#a0801762a3fe36fe32dca5f16e515478d" title="returns the number of elements " alt="" coords="384,263,532,305"/>
201 <area shape="rect" id="node14" href="structmissing__config__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="missing_config_file\l_exception::what" alt="" coords="391,329,525,370"/>
202 </map>
203 </div>
204
205 </div>
206 </div>
207 <h2 class="groupheader">Variable Documentation</h2>
208 <a id="a69b4bff6061152ff85770d725cced3cc"></a>
209 <h2 class="memtitle"><span class="permalink"><a href="#a69b4bff6061152ff85770d725cced3cc">&#9670;&nbsp;</a></span>module_name</h2>
210
211 <div class="memitem">
212 <div class="memproto">
213       <table class="memname">
214         <tr>
215           <td class="memname">const std::string module_name = &quot;u-plane&quot;</td>
216         </tr>
217       </table>
218 </div><div class="memdoc">
219
220 <p class="definition">Definition at line <a class="el" href="u__plane__performance_8cc_source.html#l00028">28</a> of file <a class="el" href="u__plane__performance_8cc_source.html">u_plane_performance.cc</a>.</p>
221
222 </div>
223 </div>
224 </div><!-- contents -->
225 <!-- start footer part -->
226 <hr class="footer"/><address class="footer"><small>
227 Generated by &#160;<a href="http://www.doxygen.org/index.html">
228 <img class="footer" src="doxygen.png" alt="doxygen"/>
229 </a> 1.8.13
230 </small></address>
231 </body>
232 </html>