add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__radioapp__frame_structure.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: xran_cp_radioapp_frameStructure Struct 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><!-- top -->
61 <div class="header">
62   <div class="summary">
63 <a href="#pub-attribs">Data Fields</a>  </div>
64   <div class="headertitle">
65 <div class="title">xran_cp_radioapp_frameStructure Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_cp_radioapp_frameStructure:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__cp__radioapp__frame_structure__coll__graph.png" border="0" usemap="#xran__cp__radioapp__frame_structure_coll__map" alt="Collaboration graph"/></div>
74 </div>
75 <table class="memberdecls">
76 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
77 Data Fields</h2></td></tr>
78 <tr class="memitem:aa4ed885cdd3c67f4df8c1f6b20cc031c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__frame_structure.html#aa4ed885cdd3c67f4df8c1f6b20cc031c">uScs</a>:4</td></tr>
79 <tr class="separator:aa4ed885cdd3c67f4df8c1f6b20cc031c"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <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__radioapp__frame_structure.html#a59e7e8f3feb686850b0cb0ae065de85b">fftSize</a>:4</td></tr>
81 <tr class="separator:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 </table>
83 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
84 <div class="textblock"><p>frame structure defined in 5.4.4.13 </p>
85
86 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00079">79</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
87 </div><h2 class="groupheader">Field Documentation</h2>
88 <a id="a59e7e8f3feb686850b0cb0ae065de85b"></a>
89 <h2 class="memtitle"><span class="permalink"><a href="#a59e7e8f3feb686850b0cb0ae065de85b">&#9670;&nbsp;</a></span>fftSize</h2>
90
91 <div class="memitem">
92 <div class="memproto">
93       <table class="memname">
94         <tr>
95           <td class="memname">uint8_t fftSize</td>
96         </tr>
97       </table>
98 </div><div class="memdoc">
99 <p>FFT size, XRAN_FFTSIZE_xxx </p>
100
101 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00081">81</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
102
103 </div>
104 </div>
105 <a id="aa4ed885cdd3c67f4df8c1f6b20cc031c"></a>
106 <h2 class="memtitle"><span class="permalink"><a href="#aa4ed885cdd3c67f4df8c1f6b20cc031c">&#9670;&nbsp;</a></span>uScs</h2>
107
108 <div class="memitem">
109 <div class="memproto">
110       <table class="memname">
111         <tr>
112           <td class="memname">uint8_t uScs</td>
113         </tr>
114       </table>
115 </div><div class="memdoc">
116 <p>sub-carrier spacing, XRAN_SCS_xxx </p>
117
118 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00080">80</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
119
120 </div>
121 </div>
122 <hr/>The documentation for this struct was generated from the following file:<ul>
123 <li><a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a></li>
124 </ul>
125 </div><!-- contents -->
126 <!-- start footer part -->
127 <hr class="footer"/><address class="footer"><small>
128 Generated by &#160;<a href="http://www.doxygen.org/index.html">
129 <img class="footer" src="doxygen.png" alt="doxygen"/>
130 </a> 1.8.13
131 </small></address>
132 </body>
133 </html>