add Doxygen documentation
[o-du/phy.git] / docs / API / structxran__cp__radioapp__section3__header.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_section3_header 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_section3_header 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_section3_header:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structxran__cp__radioapp__section3__header__coll__graph.png" border="0" usemap="#xran__cp__radioapp__section3__header_coll__map" alt="Collaboration graph"/></div>
74 <map name="xran__cp__radioapp__section3__header_coll__map" id="xran__cp__radioapp__section3__header_coll__map">
75 <area shape="rect" id="node2" href="structxran__cp__radioapp__frame_structure.html" title="{xran_cp_radioapp_frameStructure\n|+ uScs\l+ fftSize\l|}" alt="" coords="5,64,223,156"/>
76 <area shape="rect" id="node3" href="structxran__cp__radioapp__common__header.html" title="{xran_cp_radioapp_common\l_header\n|+ startSymbolId\l+ slotId\l+ subframeId\l+ frameId\l+ filterIndex\l+ payloadVer\l+ dataDirection\l+ numOfSections\l+ sectionType\l|}" alt="" coords="247,5,429,215"/>
77 <area shape="rect" id="node4" href="structxran__radioapp__ud_comp__header.html" title="{xran_radioapp_udComp\l_header\n|+ udCompMeth\l+ udIqWidth\l|}" alt="" coords="453,57,612,163"/>
78 </map>
79 </div>
80 <table class="memberdecls">
81 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
82 Data Fields</h2></td></tr>
83 <tr class="memitem:a5965943d604d681efbc50dbda73e9101"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__cp__radioapp__common__header.html">xran_cp_radioapp_common_header</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section3__header.html#a5965943d604d681efbc50dbda73e9101">cmnhdr</a></td></tr>
84 <tr class="separator:a5965943d604d681efbc50dbda73e9101"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <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__radioapp__section3__header.html#aa68c277a66312b4b90819cccc055bdb7">timeOffset</a></td></tr>
86 <tr class="separator:aa68c277a66312b4b90819cccc055bdb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:addd131fba195042d2b0b7de7c5183b6a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__cp__radioapp__frame_structure.html">xran_cp_radioapp_frameStructure</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section3__header.html#addd131fba195042d2b0b7de7c5183b6a">frameStructure</a></td></tr>
88 <tr class="separator:addd131fba195042d2b0b7de7c5183b6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <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__radioapp__section3__header.html#af57c31d64bbdb0d65fd36c9f38951328">cpLength</a></td></tr>
90 <tr class="separator:af57c31d64bbdb0d65fd36c9f38951328"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:a2c555c4732301a1ffa8b9957fbe51a76"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxran__radioapp__ud_comp__header.html">xran_radioapp_udComp_header</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxran__cp__radioapp__section3__header.html#a2c555c4732301a1ffa8b9957fbe51a76">udComp</a></td></tr>
92 <tr class="separator:a2c555c4732301a1ffa8b9957fbe51a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 </table>
94 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
95 <div class="textblock"><p>Section header definition for type 3 </p>
96
97 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00388">388</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
98 </div><h2 class="groupheader">Field Documentation</h2>
99 <a id="a5965943d604d681efbc50dbda73e9101"></a>
100 <h2 class="memtitle"><span class="permalink"><a href="#a5965943d604d681efbc50dbda73e9101">&#9670;&nbsp;</a></span>cmnhdr</h2>
101
102 <div class="memitem">
103 <div class="memproto">
104       <table class="memname">
105         <tr>
106           <td class="memname">struct <a class="el" href="structxran__cp__radioapp__common__header.html">xran_cp_radioapp_common_header</a> cmnhdr</td>
107         </tr>
108       </table>
109 </div><div class="memdoc">
110
111 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00389">389</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
112
113 </div>
114 </div>
115 <a id="af57c31d64bbdb0d65fd36c9f38951328"></a>
116 <h2 class="memtitle"><span class="permalink"><a href="#af57c31d64bbdb0d65fd36c9f38951328">&#9670;&nbsp;</a></span>cpLength</h2>
117
118 <div class="memitem">
119 <div class="memproto">
120       <table class="memname">
121         <tr>
122           <td class="memname">uint16_t cpLength</td>
123         </tr>
124       </table>
125 </div><div class="memdoc">
126 <p>5.4.4.14 cyclic prefix length </p>
127
128 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00393">393</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
129
130 </div>
131 </div>
132 <a id="addd131fba195042d2b0b7de7c5183b6a"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#addd131fba195042d2b0b7de7c5183b6a">&#9670;&nbsp;</a></span>frameStructure</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137       <table class="memname">
138         <tr>
139           <td class="memname">struct <a class="el" href="structxran__cp__radioapp__frame_structure.html">xran_cp_radioapp_frameStructure</a> frameStructure</td>
140         </tr>
141       </table>
142 </div><div class="memdoc">
143
144 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00392">392</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
145
146 </div>
147 </div>
148 <a id="aa68c277a66312b4b90819cccc055bdb7"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#aa68c277a66312b4b90819cccc055bdb7">&#9670;&nbsp;</a></span>timeOffset</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153       <table class="memname">
154         <tr>
155           <td class="memname">uint16_t timeOffset</td>
156         </tr>
157       </table>
158 </div><div class="memdoc">
159 <p>5.4.4.12 time offset </p>
160
161 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00390">390</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
162
163 </div>
164 </div>
165 <a id="a2c555c4732301a1ffa8b9957fbe51a76"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#a2c555c4732301a1ffa8b9957fbe51a76">&#9670;&nbsp;</a></span>udComp</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname">struct <a class="el" href="structxran__radioapp__ud_comp__header.html">xran_radioapp_udComp_header</a> udComp</td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176
177 <p class="definition">Definition at line <a class="el" href="xran__pkt__cp_8h_source.html#l00394">394</a> of file <a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a>.</p>
178
179 </div>
180 </div>
181 <hr/>The documentation for this struct was generated from the following file:<ul>
182 <li><a class="el" href="xran__pkt__cp_8h_source.html">xran_pkt_cp.h</a></li>
183 </ul>
184 </div><!-- contents -->
185 <!-- start footer part -->
186 <hr class="footer"/><address class="footer"><small>
187 Generated by &#160;<a href="http://www.doxygen.org/index.html">
188 <img class="footer" src="doxygen.png" alt="doxygen"/>
189 </a> 1.8.13
190 </small></address>
191 </body>
192 </html>