add Doxygen documentation
[o-du/phy.git] / docs / API / functions_f.html
diff --git a/docs/API/functions_f.html b/docs/API/functions_f.html
new file mode 100644 (file)
index 0000000..f345fc8
--- /dev/null
@@ -0,0 +1,147 @@
+<!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: Data Fields</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>
+</div><!-- top -->
+<!-- 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 class="contents">
+<div class="textblock">Here is a list of all struct and union fields with links to the structures/unions they belong to:</div>
+
+<h3><a id="index_f"></a>- f -</h3><ul>
+<li>fftSize
+: <a class="el" href="structxran__cp__header__params.html#a59e7e8f3feb686850b0cb0ae065de85b">xran_cp_header_params</a>
+, <a class="el" href="structxran__cp__radioapp__frame_structure.html#a59e7e8f3feb686850b0cb0ae065de85b">xran_cp_radioapp_frameStructure</a>
+, <a class="el" href="structxran__ru__config.html#a59e7e8f3feb686850b0cb0ae065de85b">xran_ru_config</a>
+</li>
+<li>fh_cfg
+: <a class="el" href="structxran__device__ctx.html#a4adf91126704ea524f98f461f6180c85">xran_device_ctx</a>
+</li>
+<li>fh_counters
+: <a class="el" href="structxran__device__ctx.html#ad2bc382255cb424431bb7515a796e5bf">xran_device_ctx</a>
+</li>
+<li>fh_init
+: <a class="el" href="structxran__device__ctx.html#a3842cc1a01bcaa4df37fd8c10308ff01">xran_device_ctx</a>
+</li>
+<li>fields
+: <a class="el" href="structdata__section__hdr.html#a9f1bf385f4549249e191e6563acbdecb">data_section_hdr</a>
+</li>
+<li>filePrefix
+: <a class="el" href="structxran__fh__init.html#a6a78f61ed42f876c7cfa835be5ed0942">xran_fh_init</a>
+</li>
+<li>filter_id
+: <a class="el" href="structradio__app__common__hdr.html#ab370897260617b317ee8957e470de1cc">radio_app_common_hdr</a>
+</li>
+<li>filterIdx
+: <a class="el" href="structxran__cp__header__params.html#ad5150de5e1c141cfe288f260afb00830">xran_cp_header_params</a>
+, <a class="el" href="structxran__prach__cp__config.html#ad5150de5e1c141cfe288f260afb00830">xran_prach_cp_config</a>
+</li>
+<li>filterIndex
+: <a class="el" href="structxran__cp__radioapp__common__header.html#a6275bf84e65f219845e03cf9535f893a">xran_cp_radioapp_common_header</a>
+</li>
+<li>find()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a4cf2116be00a99de7addd2c32d71f99d">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>flatten()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a6a19297e3c35ea1836a330681443e241">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>fRA
+: <a class="el" href="structx_r_a_n_prach_preamble_l_r_a_struct.html#aed8831c5fee95cb19b08e7fddb5d9658">xRANPrachPreambleLRAStruct</a>
+</li>
+<li>frame_conf
+: <a class="el" href="structxran__fh__config.html#a72b0cba491d0dd2703d684cb2c2a14cf">xran_fh_config</a>
+</li>
+<li>frame_id
+: <a class="el" href="structradio__app__common__hdr.html#a03c1016ac46b9df250b994f242cf956a">radio_app_common_hdr</a>
+</li>
+<li>frameId
+: <a class="el" href="structxran__cp__header__params.html#a048f7f66787565b266517ddaa551d98e">xran_cp_header_params</a>
+, <a class="el" href="structxran__cp__radioapp__common__header.html#a15a5e5806d950f2d75550c17b007153c">xran_cp_radioapp_common_header</a>
+</li>
+<li>frameStructure
+: <a class="el" href="structxran__cp__radioapp__section0__header.html#addd131fba195042d2b0b7de7c5183b6a">xran_cp_radioapp_section0_header</a>
+, <a class="el" href="structxran__cp__radioapp__section3__header.html#addd131fba195042d2b0b7de7c5183b6a">xran_cp_radioapp_section3_header</a>
+</li>
+<li>freqOffset
+: <a class="el" href="structxran__cp__radioapp__section3.html#a13677edb1da78e5c96fc793592142392">xran_cp_radioapp_section3</a>
+, <a class="el" href="structxran__prach__cp__config.html#a3af58496c14a1c91c015aa6ffe7dca49">xran_prach_cp_config</a>
+, <a class="el" href="structxran__section__info.html#a3af58496c14a1c91c015aa6ffe7dca49">xran_section_info</a>
+</li>
+<li>from_cbor()
+: <a class="el" href="classnlohmann_1_1basic__json.html#adc1943642176bb9091891f24bbb67416">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>from_json()
+: <a class="el" href="structnlohmann_1_1adl__serializer.html#adcdd0023173b7ae293da6cc2ffddfd06">adl_serializer&lt; typename, typename &gt;</a>
+</li>
+<li>from_msgpack()
+: <a class="el" href="classnlohmann_1_1basic__json.html#ae9e03e9dcfd9897c8c9b03a53cf02d30">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>front()
+: <a class="el" href="classnlohmann_1_1basic__json.html#a0ae6b4f9719202f7ddb334c16fb03d80">basic_json&lt; ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer &gt;</a>
+</li>
+<li>fucntional_dl()
+: <a class="el" href="class_u__plane_perf.html#aa2fb15367f40188e0a2d2c15fa6ad124">U_planePerf</a>
+</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>