add Doxygen documentation
[o-du/phy.git] / docs / API / structdata__section__compression__hdr.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: data_section_compression_hdr 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">data_section_compression_hdr Struct Reference</div>  </div>
66 </div><!--header-->
67 <div class="contents">
68
69 <p><code>#include &lt;<a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>&gt;</code></p>
70 <div class="dynheader">
71 Collaboration diagram for data_section_compression_hdr:</div>
72 <div class="dyncontent">
73 <div class="center"><img src="structdata__section__compression__hdr__coll__graph.png" border="0" usemap="#data__section__compression__hdr_coll__map" alt="Collaboration graph"/></div>
74 <map name="data__section__compression__hdr_coll__map" id="data__section__compression__hdr_coll__map">
75 <area shape="rect" id="node2" href="structcompression__hdr.html" title="{compression_hdr\n|+ ud_iq_width\l+ ud_comp_meth\l|}" alt="" coords="45,5,168,97"/>
76 </map>
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:a4638fbd317b5d0c464ef9483038564b0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcompression__hdr.html">compression_hdr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__compression__hdr.html#a4638fbd317b5d0c464ef9483038564b0">ud_comp_hdr</a></td></tr>
82 <tr class="separator:a4638fbd317b5d0c464ef9483038564b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:a73f8c890ac5a8af7cfe4947d2205e3ee"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdata__section__compression__hdr.html#a73f8c890ac5a8af7cfe4947d2205e3ee">rsrvd</a></td></tr>
84 <tr class="separator:a73f8c890ac5a8af7cfe4947d2205e3ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 </table>
86 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
87 <div class="textblock">
88 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00090">90</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
89 </div><h2 class="groupheader">Field Documentation</h2>
90 <a id="a73f8c890ac5a8af7cfe4947d2205e3ee"></a>
91 <h2 class="memtitle"><span class="permalink"><a href="#a73f8c890ac5a8af7cfe4947d2205e3ee">&#9670;&nbsp;</a></span>rsrvd</h2>
92
93 <div class="memitem">
94 <div class="memproto">
95       <table class="memname">
96         <tr>
97           <td class="memname">uint8_t rsrvd</td>
98         </tr>
99       </table>
100 </div><div class="memdoc">
101 <p>This parameter provides 1 byte for future definition, should be set to all zeros by the sender and ignored by the receiver. This field is only present when udCompHdr is present, and is absent when the static IQ format and compression method is configured via the M-Plane </p>
102
103 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00093">93</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
104
105 </div>
106 </div>
107 <a id="a4638fbd317b5d0c464ef9483038564b0"></a>
108 <h2 class="memtitle"><span class="permalink"><a href="#a4638fbd317b5d0c464ef9483038564b0">&#9670;&nbsp;</a></span>ud_comp_hdr</h2>
109
110 <div class="memitem">
111 <div class="memproto">
112       <table class="memname">
113         <tr>
114           <td class="memname">struct <a class="el" href="structcompression__hdr.html">compression_hdr</a> ud_comp_hdr</td>
115         </tr>
116       </table>
117 </div><div class="memdoc">
118
119 <p class="definition">Definition at line <a class="el" href="xran__pkt__up_8h_source.html#l00092">92</a> of file <a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a>.</p>
120
121 </div>
122 </div>
123 <hr/>The documentation for this struct was generated from the following file:<ul>
124 <li><a class="el" href="xran__pkt__up_8h_source.html">xran_pkt_up.h</a></li>
125 </ul>
126 </div><!-- contents -->
127 <!-- start footer part -->
128 <hr class="footer"/><address class="footer"><small>
129 Generated by &#160;<a href="http://www.doxygen.org/index.html">
130 <img class="footer" src="doxygen.png" alt="doxygen"/>
131 </a> 1.8.13
132 </small></address>
133 </body>
134 </html>