add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__header__params.html
diff --git a/docs/API/structxran__cp__header__params.html b/docs/API/structxran__cp__header__params.html
new file mode 100644 (file)
index 0000000..9dd5068
--- /dev/null
@@ -0,0 +1,311 @@
+<!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: xran_cp_header_params Struct 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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-attribs">Data Fields</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_cp_header_params Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for xran_cp_header_params:</div>
+<div class="dyncontent">
+<div class="center"><img src="structxran__cp__header__params__coll__graph.png" border="0" usemap="#xran__cp__header__params_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
+Data Fields</h2></td></tr>
+<tr class="memitem:ad5150de5e1c141cfe288f260afb00830"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#ad5150de5e1c141cfe288f260afb00830">filterIdx</a></td></tr>
+<tr class="separator:ad5150de5e1c141cfe288f260afb00830"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a048f7f66787565b266517ddaa551d98e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a048f7f66787565b266517ddaa551d98e">frameId</a></td></tr>
+<tr class="separator:a048f7f66787565b266517ddaa551d98e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a45cd2998ed056e5139a76bf36053ed14"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a45cd2998ed056e5139a76bf36053ed14">subframeId</a></td></tr>
+<tr class="separator:a45cd2998ed056e5139a76bf36053ed14"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0eb3f725109bb1afb9094b025af26678"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a0eb3f725109bb1afb9094b025af26678">slotId</a></td></tr>
+<tr class="separator:a0eb3f725109bb1afb9094b025af26678"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac54814779041bec5dcf8aec288d69b06"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#ac54814779041bec5dcf8aec288d69b06">startSymId</a></td></tr>
+<tr class="separator:ac54814779041bec5dcf8aec288d69b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a59e7e8f3feb686850b0cb0ae065de85b">fftSize</a></td></tr>
+<tr class="separator:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae470e3869d1cbf07cd5f78ab6709b9e1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#ae470e3869d1cbf07cd5f78ab6709b9e1">scs</a></td></tr>
+<tr class="separator:ae470e3869d1cbf07cd5f78ab6709b9e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1520b1ef6131bff6c14b88d849c266c5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a1520b1ef6131bff6c14b88d849c266c5">iqWidth</a></td></tr>
+<tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a1e4a3c43fc7865c6520471fb9ba8501f">compMeth</a></td></tr>
+<tr class="separator:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a32f1b5994f68c2670b4db46afdd152f1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#a32f1b5994f68c2670b4db46afdd152f1">numUEs</a></td></tr>
+<tr class="separator:a32f1b5994f68c2670b4db46afdd152f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa68c277a66312b4b90819cccc055bdb7"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#aa68c277a66312b4b90819cccc055bdb7">timeOffset</a></td></tr>
+<tr class="separator:aa68c277a66312b4b90819cccc055bdb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af57c31d64bbdb0d65fd36c9f38951328"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__header__params.html#af57c31d64bbdb0d65fd36c9f38951328">cpLength</a></td></tr>
+<tr class="separator:af57c31d64bbdb0d65fd36c9f38951328"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>This structure contains the information to generate the section header of C-Plane message </p>
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00275">275</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+</div><h2 class="groupheader">Field Documentation</h2>
+<a id="a1e4a3c43fc7865c6520471fb9ba8501f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1e4a3c43fc7865c6520471fb9ba8501f">&#9670;&nbsp;</a></span>compMeth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t compMeth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00287">287</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="af57c31d64bbdb0d65fd36c9f38951328"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af57c31d64bbdb0d65fd36c9f38951328">&#9670;&nbsp;</a></span>cpLength</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t cpLength</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00290">290</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a59e7e8f3feb686850b0cb0ae065de85b"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a59e7e8f3feb686850b0cb0ae065de85b">&#9670;&nbsp;</a></span>fftSize</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t fftSize</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00284">284</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ad5150de5e1c141cfe288f260afb00830"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad5150de5e1c141cfe288f260afb00830">&#9670;&nbsp;</a></span>filterIdx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t filterIdx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00277">277</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a048f7f66787565b266517ddaa551d98e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a048f7f66787565b266517ddaa551d98e">&#9670;&nbsp;</a></span>frameId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t frameId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00278">278</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t iqWidth</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00286">286</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a32f1b5994f68c2670b4db46afdd152f1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a32f1b5994f68c2670b4db46afdd152f1">&#9670;&nbsp;</a></span>numUEs</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t numUEs</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00288">288</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ae470e3869d1cbf07cd5f78ab6709b9e1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae470e3869d1cbf07cd5f78ab6709b9e1">&#9670;&nbsp;</a></span>scs</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t scs</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00285">285</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a0eb3f725109bb1afb9094b025af26678"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0eb3f725109bb1afb9094b025af26678">&#9670;&nbsp;</a></span>slotId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t slotId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00280">280</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="ac54814779041bec5dcf8aec288d69b06"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac54814779041bec5dcf8aec288d69b06">&#9670;&nbsp;</a></span>startSymId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t startSymId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00281">281</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="a45cd2998ed056e5139a76bf36053ed14"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a45cd2998ed056e5139a76bf36053ed14">&#9670;&nbsp;</a></span>subframeId</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t subframeId</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00279">279</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<a id="aa68c277a66312b4b90819cccc055bdb7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa68c277a66312b4b90819cccc055bdb7">&#9670;&nbsp;</a></span>timeOffset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint16_t timeOffset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="xran__cp__api_8h_source.html#l00289">289</a> of file <a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</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>