add Doxygen documentation
[o-du/phy.git] / docs / API / structxranlib__compress__request.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: xranlib_compress_request 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">xranlib_compress_request Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p>Request structure containing pointer to data and its length.  
70  <a href="structxranlib__compress__request.html#details">More...</a></p>
71
72 <p><code>#include &lt;<a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>&gt;</code></p>
73 <div class="dynheader">
74 Collaboration diagram for xranlib_compress_request:</div>
75 <div class="dyncontent">
76 <div class="center"><img src="structxranlib__compress__request__coll__graph.png" border="0" usemap="#xranlib__compress__request_coll__map" alt="Collaboration graph"/></div>
77 </div>
78 <table class="memberdecls">
79 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
80 Data Fields</h2></td></tr>
81 <tr class="memitem:a06bde7ceb81ae7d8d8a101d7cfe4bb25"><td class="memItemLeft" align="right" valign="top">int16_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxranlib__compress__request.html#a06bde7ceb81ae7d8d8a101d7cfe4bb25">data_in</a></td></tr>
82 <tr class="separator:a06bde7ceb81ae7d8d8a101d7cfe4bb25"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a8ab4fa409402862ead0d17e13edeeb62"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxranlib__compress__request.html#a8ab4fa409402862ead0d17e13edeeb62">numRBs</a></td></tr>
84 <tr class="separator:a8ab4fa409402862ead0d17e13edeeb62"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:ad73157f14fa98c54fb563244c1327933"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxranlib__compress__request.html#ad73157f14fa98c54fb563244c1327933">compMethod</a></td></tr>
86 <tr class="separator:ad73157f14fa98c54fb563244c1327933"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxranlib__compress__request.html#a36f5a0cedd274c3ec55f81535f06e0de">iqWidth</a></td></tr>
88 <tr class="separator:a36f5a0cedd274c3ec55f81535f06e0de"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:a6858c4011b5cad020222e9ca5c2786f5"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxranlib__compress__request.html#a6858c4011b5cad020222e9ca5c2786f5">len</a></td></tr>
90 <tr class="separator:a6858c4011b5cad020222e9ca5c2786f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 </table>
92 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
93 <div class="textblock"><p>Request structure containing pointer to data and its length. </p>
94
95 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00037">37</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
96 </div><h2 class="groupheader">Field Documentation</h2>
97 <a id="ad73157f14fa98c54fb563244c1327933"></a>
98 <h2 class="memtitle"><span class="permalink"><a href="#ad73157f14fa98c54fb563244c1327933">&#9670;&nbsp;</a></span>compMethod</h2>
99
100 <div class="memitem">
101 <div class="memproto">
102       <table class="memname">
103         <tr>
104           <td class="memname">int16_t compMethod</td>
105         </tr>
106       </table>
107 </div><div class="memdoc">
108 <p>Compression method </p>
109
110 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00040">40</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
111
112 </div>
113 </div>
114 <a id="a06bde7ceb81ae7d8d8a101d7cfe4bb25"></a>
115 <h2 class="memtitle"><span class="permalink"><a href="#a06bde7ceb81ae7d8d8a101d7cfe4bb25">&#9670;&nbsp;</a></span>data_in</h2>
116
117 <div class="memitem">
118 <div class="memproto">
119       <table class="memname">
120         <tr>
121           <td class="memname">int16_t* data_in</td>
122         </tr>
123       </table>
124 </div><div class="memdoc">
125 <p>Pointer to data to compress. </p>
126
127 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00038">38</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
128
129 </div>
130 </div>
131 <a id="a36f5a0cedd274c3ec55f81535f06e0de"></a>
132 <h2 class="memtitle"><span class="permalink"><a href="#a36f5a0cedd274c3ec55f81535f06e0de">&#9670;&nbsp;</a></span>iqWidth</h2>
133
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname">int16_t iqWidth</td>
139         </tr>
140       </table>
141 </div><div class="memdoc">
142 <p>Bit size </p>
143
144 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00041">41</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
145
146 </div>
147 </div>
148 <a id="a6858c4011b5cad020222e9ca5c2786f5"></a>
149 <h2 class="memtitle"><span class="permalink"><a href="#a6858c4011b5cad020222e9ca5c2786f5">&#9670;&nbsp;</a></span>len</h2>
150
151 <div class="memitem">
152 <div class="memproto">
153       <table class="memname">
154         <tr>
155           <td class="memname">int32_t len</td>
156         </tr>
157       </table>
158 </div><div class="memdoc">
159 <p>Length of input buffer in bytes </p>
160
161 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00042">42</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
162
163 </div>
164 </div>
165 <a id="a8ab4fa409402862ead0d17e13edeeb62"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#a8ab4fa409402862ead0d17e13edeeb62">&#9670;&nbsp;</a></span>numRBs</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname">int16_t numRBs</td>
173         </tr>
174       </table>
175 </div><div class="memdoc">
176 <p>numRBs </p>
177
178 <p class="definition">Definition at line <a class="el" href="xran__compression_8h_source.html#l00039">39</a> of file <a class="el" href="xran__compression_8h_source.html">xran_compression.h</a>.</p>
179
180 </div>
181 </div>
182 <hr/>The documentation for this struct was generated from the following file:<ul>
183 <li><a class="el" href="xran__compression_8h_source.html">xran_compression.h</a></li>
184 </ul>
185 </div><!-- contents -->
186 <!-- start footer part -->
187 <hr class="footer"/><address class="footer"><small>
188 Generated by &#160;<a href="http://www.doxygen.org/index.html">
189 <img class="footer" src="doxygen.png" alt="doxygen"/>
190 </a> 1.8.13
191 </small></address>
192 </body>
193 </html>