add Doxygen documentation
[o-du/phy.git] / docs / API / structx_r_a_n_prach_config_table_struct.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: xRANPrachConfigTableStruct 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">xRANPrachConfigTableStruct Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__common_8h_source.html">xran_common.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for xRANPrachConfigTableStruct:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structx_r_a_n_prach_config_table_struct__coll__graph.png" border="0" usemap="#x_r_a_n_prach_config_table_struct_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:ac80f2088871de674e27c76994d18c9e4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#ac80f2088871de674e27c76994d18c9e4">prachConfigIdx</a></td></tr>
79 <tr class="separator:ac80f2088871de674e27c76994d18c9e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:acda2526836f55a54072c7582b0735ec6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#acda2526836f55a54072c7582b0735ec6">preambleFmrt</a> [<a class="el" href="xran__common_8h.html#ad90730954cdd8ddb772622a642ef337a">XRAN_PRACH_CANDIDATE_PREAMBLE</a>]</td></tr>
81 <tr class="separator:acda2526836f55a54072c7582b0735ec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a0f561e77fa0f040b637f4e04f6cd8078">x</a></td></tr>
83 <tr class="separator:a0f561e77fa0f040b637f4e04f6cd8078"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a1d627e83c5e0ae889b71ea0508991f29"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a1d627e83c5e0ae889b71ea0508991f29">y</a> [<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td></tr>
85 <tr class="separator:a1d627e83c5e0ae889b71ea0508991f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:a48f74053065142fe9cffa09c460965e1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a48f74053065142fe9cffa09c460965e1">slotNr</a> [<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td></tr>
87 <tr class="separator:a48f74053065142fe9cffa09c460965e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:ad86e3c05257c9e5fbfce20441a48fdec"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#ad86e3c05257c9e5fbfce20441a48fdec">slotNrNum</a></td></tr>
89 <tr class="separator:ad86e3c05257c9e5fbfce20441a48fdec"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a232bf4a599983638ff369472234af97c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a232bf4a599983638ff369472234af97c">startingSym</a></td></tr>
91 <tr class="separator:a232bf4a599983638ff369472234af97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a855041f3139611ca7478502e3241b2f1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a855041f3139611ca7478502e3241b2f1">nrofPrachInSlot</a></td></tr>
93 <tr class="separator:a855041f3139611ca7478502e3241b2f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a2e544eaae35a5756272d62af4fa53a19"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#a2e544eaae35a5756272d62af4fa53a19">occassionsInPrachSlot</a></td></tr>
95 <tr class="separator:a2e544eaae35a5756272d62af4fa53a19"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:ae7b193beba4cc63eed61b211bae9e802"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structx_r_a_n_prach_config_table_struct.html#ae7b193beba4cc63eed61b211bae9e802">duration</a></td></tr>
97 <tr class="separator:ae7b193beba4cc63eed61b211bae9e802"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 </table>
99 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
100 <div class="textblock">
101 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00102">102</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
102 </div><h2 class="groupheader">Field Documentation</h2>
103 <a id="ae7b193beba4cc63eed61b211bae9e802"></a>
104 <h2 class="memtitle"><span class="permalink"><a href="#ae7b193beba4cc63eed61b211bae9e802">&#9670;&nbsp;</a></span>duration</h2>
105
106 <div class="memitem">
107 <div class="memproto">
108       <table class="memname">
109         <tr>
110           <td class="memname">uint8_t duration</td>
111         </tr>
112       </table>
113 </div><div class="memdoc">
114
115 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00113">113</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
116
117 </div>
118 </div>
119 <a id="a855041f3139611ca7478502e3241b2f1"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#a855041f3139611ca7478502e3241b2f1">&#9670;&nbsp;</a></span>nrofPrachInSlot</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124       <table class="memname">
125         <tr>
126           <td class="memname">uint8_t nrofPrachInSlot</td>
127         </tr>
128       </table>
129 </div><div class="memdoc">
130
131 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00111">111</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
132
133 </div>
134 </div>
135 <a id="a2e544eaae35a5756272d62af4fa53a19"></a>
136 <h2 class="memtitle"><span class="permalink"><a href="#a2e544eaae35a5756272d62af4fa53a19">&#9670;&nbsp;</a></span>occassionsInPrachSlot</h2>
137
138 <div class="memitem">
139 <div class="memproto">
140       <table class="memname">
141         <tr>
142           <td class="memname">uint8_t occassionsInPrachSlot</td>
143         </tr>
144       </table>
145 </div><div class="memdoc">
146
147 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00112">112</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
148
149 </div>
150 </div>
151 <a id="ac80f2088871de674e27c76994d18c9e4"></a>
152 <h2 class="memtitle"><span class="permalink"><a href="#ac80f2088871de674e27c76994d18c9e4">&#9670;&nbsp;</a></span>prachConfigIdx</h2>
153
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname">uint8_t prachConfigIdx</td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162
163 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00104">104</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
164
165 </div>
166 </div>
167 <a id="acda2526836f55a54072c7582b0735ec6"></a>
168 <h2 class="memtitle"><span class="permalink"><a href="#acda2526836f55a54072c7582b0735ec6">&#9670;&nbsp;</a></span>preambleFmrt</h2>
169
170 <div class="memitem">
171 <div class="memproto">
172       <table class="memname">
173         <tr>
174           <td class="memname">uint8_t preambleFmrt[<a class="el" href="xran__common_8h.html#ad90730954cdd8ddb772622a642ef337a">XRAN_PRACH_CANDIDATE_PREAMBLE</a>]</td>
175         </tr>
176       </table>
177 </div><div class="memdoc">
178
179 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00105">105</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
180
181 </div>
182 </div>
183 <a id="a48f74053065142fe9cffa09c460965e1"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#a48f74053065142fe9cffa09c460965e1">&#9670;&nbsp;</a></span>slotNr</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname">uint8_t slotNr[<a class="el" href="xran__common_8h.html#af7a48e76794ce5d801ab6d0f848abb53">XRAN_PRACH_CANDIDATE_SLOT</a>]</td>
191         </tr>
192       </table>
193 </div><div class="memdoc">
194
195 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00108">108</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
196
197 </div>
198 </div>
199 <a id="ad86e3c05257c9e5fbfce20441a48fdec"></a>
200 <h2 class="memtitle"><span class="permalink"><a href="#ad86e3c05257c9e5fbfce20441a48fdec">&#9670;&nbsp;</a></span>slotNrNum</h2>
201
202 <div class="memitem">
203 <div class="memproto">
204       <table class="memname">
205         <tr>
206           <td class="memname">uint8_t slotNrNum</td>
207         </tr>
208       </table>
209 </div><div class="memdoc">
210
211 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00109">109</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
212
213 </div>
214 </div>
215 <a id="a232bf4a599983638ff369472234af97c"></a>
216 <h2 class="memtitle"><span class="permalink"><a href="#a232bf4a599983638ff369472234af97c">&#9670;&nbsp;</a></span>startingSym</h2>
217
218 <div class="memitem">
219 <div class="memproto">
220       <table class="memname">
221         <tr>
222           <td class="memname">uint8_t startingSym</td>
223         </tr>
224       </table>
225 </div><div class="memdoc">
226
227 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00110">110</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
228
229 </div>
230 </div>
231 <a id="a0f561e77fa0f040b637f4e04f6cd8078"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#a0f561e77fa0f040b637f4e04f6cd8078">&#9670;&nbsp;</a></span>x</h2>
233
234 <div class="memitem">
235 <div class="memproto">
236       <table class="memname">
237         <tr>
238           <td class="memname">uint8_t x</td>
239         </tr>
240       </table>
241 </div><div class="memdoc">
242
243 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00106">106</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
244
245 </div>
246 </div>
247 <a id="a1d627e83c5e0ae889b71ea0508991f29"></a>
248 <h2 class="memtitle"><span class="permalink"><a href="#a1d627e83c5e0ae889b71ea0508991f29">&#9670;&nbsp;</a></span>y</h2>
249
250 <div class="memitem">
251 <div class="memproto">
252       <table class="memname">
253         <tr>
254           <td class="memname">uint8_t y[<a class="el" href="xran__common_8h.html#a342c40a4877f7760c65eca32523efea1">XRAN_PRACH_CANDIDATE_Y</a>]</td>
255         </tr>
256       </table>
257 </div><div class="memdoc">
258
259 <p class="definition">Definition at line <a class="el" href="xran__common_8h_source.html#l00107">107</a> of file <a class="el" href="xran__common_8h_source.html">xran_common.h</a>.</p>
260
261 </div>
262 </div>
263 <hr/>The documentation for this struct was generated from the following file:<ul>
264 <li><a class="el" href="xran__common_8h_source.html">xran_common.h</a></li>
265 </ul>
266 </div><!-- contents -->
267 <!-- start footer part -->
268 <hr class="footer"/><address class="footer"><small>
269 Generated by &#160;<a href="http://www.doxygen.org/index.html">
270 <img class="footer" src="doxygen.png" alt="doxygen"/>
271 </a> 1.8.13
272 </small></address>
273 </body>
274 </html>