add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__header__params.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_header_params 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_header_params Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xran_cp_header_params:</div>
72 <div class="dyncontent">
73 <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>
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: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>
79 <tr class="separator:ad5150de5e1c141cfe288f260afb00830"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <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>
81 <tr class="separator:a048f7f66787565b266517ddaa551d98e"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <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>
83 <tr class="separator:a45cd2998ed056e5139a76bf36053ed14"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <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>
85 <tr class="separator:a0eb3f725109bb1afb9094b025af26678"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <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>
87 <tr class="separator:ac54814779041bec5dcf8aec288d69b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <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>
89 <tr class="separator:a59e7e8f3feb686850b0cb0ae065de85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <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>
91 <tr class="separator:ae470e3869d1cbf07cd5f78ab6709b9e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <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>
93 <tr class="separator:a1520b1ef6131bff6c14b88d849c266c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <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>
95 <tr class="separator:a1e4a3c43fc7865c6520471fb9ba8501f"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <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>
97 <tr class="separator:a32f1b5994f68c2670b4db46afdd152f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <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>
99 <tr class="separator:aa68c277a66312b4b90819cccc055bdb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 <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>
101 <tr class="separator:af57c31d64bbdb0d65fd36c9f38951328"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 </table>
103 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
104 <div class="textblock"><p>This structure contains the information to generate the section header of C-Plane message </p>
105
106 <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>
107 </div><h2 class="groupheader">Field Documentation</h2>
108 <a id="a1e4a3c43fc7865c6520471fb9ba8501f"></a>
109 <h2 class="memtitle"><span class="permalink"><a href="#a1e4a3c43fc7865c6520471fb9ba8501f">&#9670;&nbsp;</a></span>compMeth</h2>
110
111 <div class="memitem">
112 <div class="memproto">
113       <table class="memname">
114         <tr>
115           <td class="memname">uint8_t compMeth</td>
116         </tr>
117       </table>
118 </div><div class="memdoc">
119
120 <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>
121
122 </div>
123 </div>
124 <a id="af57c31d64bbdb0d65fd36c9f38951328"></a>
125 <h2 class="memtitle"><span class="permalink"><a href="#af57c31d64bbdb0d65fd36c9f38951328">&#9670;&nbsp;</a></span>cpLength</h2>
126
127 <div class="memitem">
128 <div class="memproto">
129       <table class="memname">
130         <tr>
131           <td class="memname">uint16_t cpLength</td>
132         </tr>
133       </table>
134 </div><div class="memdoc">
135
136 <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>
137
138 </div>
139 </div>
140 <a id="a59e7e8f3feb686850b0cb0ae065de85b"></a>
141 <h2 class="memtitle"><span class="permalink"><a href="#a59e7e8f3feb686850b0cb0ae065de85b">&#9670;&nbsp;</a></span>fftSize</h2>
142
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname">uint8_t fftSize</td>
148         </tr>
149       </table>
150 </div><div class="memdoc">
151
152 <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>
153
154 </div>
155 </div>
156 <a id="ad5150de5e1c141cfe288f260afb00830"></a>
157 <h2 class="memtitle"><span class="permalink"><a href="#ad5150de5e1c141cfe288f260afb00830">&#9670;&nbsp;</a></span>filterIdx</h2>
158
159 <div class="memitem">
160 <div class="memproto">
161       <table class="memname">
162         <tr>
163           <td class="memname">uint8_t filterIdx</td>
164         </tr>
165       </table>
166 </div><div class="memdoc">
167
168 <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>
169
170 </div>
171 </div>
172 <a id="a048f7f66787565b266517ddaa551d98e"></a>
173 <h2 class="memtitle"><span class="permalink"><a href="#a048f7f66787565b266517ddaa551d98e">&#9670;&nbsp;</a></span>frameId</h2>
174
175 <div class="memitem">
176 <div class="memproto">
177       <table class="memname">
178         <tr>
179           <td class="memname">uint8_t frameId</td>
180         </tr>
181       </table>
182 </div><div class="memdoc">
183
184 <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>
185
186 </div>
187 </div>
188 <a id="a1520b1ef6131bff6c14b88d849c266c5"></a>
189 <h2 class="memtitle"><span class="permalink"><a href="#a1520b1ef6131bff6c14b88d849c266c5">&#9670;&nbsp;</a></span>iqWidth</h2>
190
191 <div class="memitem">
192 <div class="memproto">
193       <table class="memname">
194         <tr>
195           <td class="memname">uint8_t iqWidth</td>
196         </tr>
197       </table>
198 </div><div class="memdoc">
199
200 <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>
201
202 </div>
203 </div>
204 <a id="a32f1b5994f68c2670b4db46afdd152f1"></a>
205 <h2 class="memtitle"><span class="permalink"><a href="#a32f1b5994f68c2670b4db46afdd152f1">&#9670;&nbsp;</a></span>numUEs</h2>
206
207 <div class="memitem">
208 <div class="memproto">
209       <table class="memname">
210         <tr>
211           <td class="memname">uint8_t numUEs</td>
212         </tr>
213       </table>
214 </div><div class="memdoc">
215
216 <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>
217
218 </div>
219 </div>
220 <a id="ae470e3869d1cbf07cd5f78ab6709b9e1"></a>
221 <h2 class="memtitle"><span class="permalink"><a href="#ae470e3869d1cbf07cd5f78ab6709b9e1">&#9670;&nbsp;</a></span>scs</h2>
222
223 <div class="memitem">
224 <div class="memproto">
225       <table class="memname">
226         <tr>
227           <td class="memname">uint8_t scs</td>
228         </tr>
229       </table>
230 </div><div class="memdoc">
231
232 <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>
233
234 </div>
235 </div>
236 <a id="a0eb3f725109bb1afb9094b025af26678"></a>
237 <h2 class="memtitle"><span class="permalink"><a href="#a0eb3f725109bb1afb9094b025af26678">&#9670;&nbsp;</a></span>slotId</h2>
238
239 <div class="memitem">
240 <div class="memproto">
241       <table class="memname">
242         <tr>
243           <td class="memname">uint8_t slotId</td>
244         </tr>
245       </table>
246 </div><div class="memdoc">
247
248 <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>
249
250 </div>
251 </div>
252 <a id="ac54814779041bec5dcf8aec288d69b06"></a>
253 <h2 class="memtitle"><span class="permalink"><a href="#ac54814779041bec5dcf8aec288d69b06">&#9670;&nbsp;</a></span>startSymId</h2>
254
255 <div class="memitem">
256 <div class="memproto">
257       <table class="memname">
258         <tr>
259           <td class="memname">uint8_t startSymId</td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263
264 <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>
265
266 </div>
267 </div>
268 <a id="a45cd2998ed056e5139a76bf36053ed14"></a>
269 <h2 class="memtitle"><span class="permalink"><a href="#a45cd2998ed056e5139a76bf36053ed14">&#9670;&nbsp;</a></span>subframeId</h2>
270
271 <div class="memitem">
272 <div class="memproto">
273       <table class="memname">
274         <tr>
275           <td class="memname">uint8_t subframeId</td>
276         </tr>
277       </table>
278 </div><div class="memdoc">
279
280 <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>
281
282 </div>
283 </div>
284 <a id="aa68c277a66312b4b90819cccc055bdb7"></a>
285 <h2 class="memtitle"><span class="permalink"><a href="#aa68c277a66312b4b90819cccc055bdb7">&#9670;&nbsp;</a></span>timeOffset</h2>
286
287 <div class="memitem">
288 <div class="memproto">
289       <table class="memname">
290         <tr>
291           <td class="memname">uint16_t timeOffset</td>
292         </tr>
293       </table>
294 </div><div class="memdoc">
295
296 <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>
297
298 </div>
299 </div>
300 <hr/>The documentation for this struct was generated from the following file:<ul>
301 <li><a class="el" href="xran__cp__api_8h_source.html">xran_cp_api.h</a></li>
302 </ul>
303 </div><!-- contents -->
304 <!-- start footer part -->
305 <hr class="footer"/><address class="footer"><small>
306 Generated by &#160;<a href="http://www.doxygen.org/index.html">
307 <img class="footer" src="doxygen.png" alt="doxygen"/>
308 </a> 1.8.13
309 </small></address>
310 </body>
311 </html>