<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.2.2 C++ API: metadata.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU Radio 3.2.2 C++ API</div> </td> </tr> </tbody> </table> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('metadata_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>metadata.h</h1> </div> </div> <div class="contents"> <a href="metadata_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright 2008 Free Software Foundation, Inc.</span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * This program is free software: you can redistribute it and/or modify</span> <a name="l00006"></a>00006 <span class="comment"> * it under the terms of the GNU General Public License as published by</span> <a name="l00007"></a>00007 <span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span> <a name="l00008"></a>00008 <span class="comment"> * (at your option) any later version.</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * This program is distributed in the hope that it will be useful,</span> <a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> <a name="l00013"></a>00013 <span class="comment"> * GNU General Public License for more details.</span> <a name="l00014"></a>00014 <span class="comment"> *</span> <a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License</span> <a name="l00016"></a>00016 <span class="comment"> * along with this program. If not, see <http://www.gnu.org/licenses/>.</span> <a name="l00017"></a>00017 <span class="comment"> */</span> <a name="l00018"></a>00018 <span class="preprocessor">#ifndef INCLUDED_USRP2_METADATA_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_METADATA_H</span> <a name="l00020"></a>00020 <span class="preprocessor"></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <stdint.h></span> <a name="l00022"></a>00022 <a name="l00023"></a>00023 <span class="keyword">namespace </span>usrp2 { <a name="l00024"></a>00024 <span class="comment"></span> <a name="l00025"></a>00025 <span class="comment"> //! type of the timestamp returned from the USRP2 FPGA</span> <a name="l00026"></a>00026 <span class="comment"></span> <span class="keyword">typedef</span> uint32_t fpga_timestamp; <a name="l00027"></a>00027 <span class="comment"></span> <a name="l00028"></a>00028 <span class="comment"> /*!</span> <a name="l00029"></a>00029 <span class="comment"> * \brief metadata associated with received frames</span> <a name="l00030"></a>00030 <span class="comment"> * \ingroup usrp2</span> <a name="l00031"></a>00031 <span class="comment"> */</span> <a name="l00032"></a><a class="code" href="structusrp2_1_1rx__metadata.html">00032</a> <span class="keyword">struct </span><a class="code" href="structusrp2_1_1rx__metadata.html" title="metadata associated with received frames">rx_metadata</a> { <a name="l00033"></a><a class="code" href="structusrp2_1_1rx__metadata.html#aa72f309db2dbf9a2fb69be6c75704f9b">00033</a> uint32_t <a class="code" href="structusrp2_1_1rx__metadata.html#aa72f309db2dbf9a2fb69be6c75704f9b">word0</a>; <span class="comment">//< debugging, extensions</span> <a name="l00034"></a><a class="code" href="structusrp2_1_1rx__metadata.html#a4cbfe1de64c67a187392f08220e2cdbe">00034</a> fpga_timestamp <a class="code" href="structusrp2_1_1rx__metadata.html#a4cbfe1de64c67a187392f08220e2cdbe">timestamp</a>; <span class="comment">//< time that first sample of frame was received</span> <a name="l00035"></a><a class="code" href="structusrp2_1_1rx__metadata.html#a3b28eb9368e356c8144583ca97577c7c">00035</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1rx__metadata.html#a3b28eb9368e356c8144583ca97577c7c">start_of_burst</a> : 1; <span class="comment">//< this frame is the start of a burst</span> <a name="l00036"></a><a class="code" href="structusrp2_1_1rx__metadata.html#af9833958cfa3f04437681e0ed08e7054">00036</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1rx__metadata.html#af9833958cfa3f04437681e0ed08e7054">end_of_burst</a> : 1; <span class="comment">//< this frame is the end of a burst</span> <a name="l00037"></a><a class="code" href="structusrp2_1_1rx__metadata.html#af2d939a710e1583e4fbc16c7782fdbd1">00037</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1rx__metadata.html#af2d939a710e1583e4fbc16c7782fdbd1">rx_overrun</a> : 1; <span class="comment">//< An Rx overrun occurred in the FPGA</span> <a name="l00038"></a>00038 <span class="comment">// rssi</span> <a name="l00039"></a>00039 <span class="comment">// agc_mode</span> <a name="l00040"></a>00040 <a name="l00041"></a><a class="code" href="structusrp2_1_1rx__metadata.html#acde017093e77156e5e6ab55a14a0da39">00041</a> <a class="code" href="structusrp2_1_1rx__metadata.html#acde017093e77156e5e6ab55a14a0da39">rx_metadata</a>() : <a name="l00042"></a>00042 <a class="code" href="structusrp2_1_1rx__metadata.html#aa72f309db2dbf9a2fb69be6c75704f9b">word0</a>(0), <a class="code" href="structusrp2_1_1rx__metadata.html#a4cbfe1de64c67a187392f08220e2cdbe">timestamp</a>(0), <a class="code" href="structusrp2_1_1rx__metadata.html#a3b28eb9368e356c8144583ca97577c7c">start_of_burst</a>(0), <a class="code" href="structusrp2_1_1rx__metadata.html#af9833958cfa3f04437681e0ed08e7054">end_of_burst</a>(0), <a class="code" href="structusrp2_1_1rx__metadata.html#af2d939a710e1583e4fbc16c7782fdbd1">rx_overrun</a>(0) {} <a name="l00043"></a>00043 }; <a name="l00044"></a>00044 <span class="comment"></span> <a name="l00045"></a>00045 <span class="comment"> /*!</span> <a name="l00046"></a>00046 <span class="comment"> * \brief metadata associated with transmitted frames</span> <a name="l00047"></a>00047 <span class="comment"> * \ingroup usrp2</span> <a name="l00048"></a>00048 <span class="comment"> */</span> <a name="l00049"></a><a class="code" href="structusrp2_1_1tx__metadata.html">00049</a> <span class="keyword">struct </span><a class="code" href="structusrp2_1_1tx__metadata.html" title="metadata associated with transmitted frames">tx_metadata</a> { <a name="l00050"></a><a class="code" href="structusrp2_1_1tx__metadata.html#ac9383e8f117c1ab8360f97a22e78bf5f">00050</a> fpga_timestamp <a class="code" href="structusrp2_1_1tx__metadata.html#ac9383e8f117c1ab8360f97a22e78bf5f">timestamp</a>; <span class="comment">//< time to transmit first sample of frame</span> <a name="l00051"></a><a class="code" href="structusrp2_1_1tx__metadata.html#a20c9f34fc7b31f6a7c69195e661593f0">00051</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1tx__metadata.html#a20c9f34fc7b31f6a7c69195e661593f0">send_now</a> : 1; <span class="comment">//< ignore timestamp, send now</span> <a name="l00052"></a><a class="code" href="structusrp2_1_1tx__metadata.html#ae81dd42d707b24aa3b4fc7ab7dc73778">00052</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1tx__metadata.html#ae81dd42d707b24aa3b4fc7ab7dc73778">start_of_burst</a> : 1; <span class="comment">//< this frame is the start of a burst</span> <a name="l00053"></a><a class="code" href="structusrp2_1_1tx__metadata.html#afc2a15efbafed55ba70474e43a7075eb">00053</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structusrp2_1_1tx__metadata.html#afc2a15efbafed55ba70474e43a7075eb">end_of_burst</a> : 1; <span class="comment">//< this frame is the end of a burst</span> <a name="l00054"></a>00054 <span class="comment">// ...</span> <a name="l00055"></a>00055 <a name="l00056"></a><a class="code" href="structusrp2_1_1tx__metadata.html#a6b33d8fdab2aea472c6e538a559c98a4">00056</a> <a class="code" href="structusrp2_1_1tx__metadata.html#a6b33d8fdab2aea472c6e538a559c98a4">tx_metadata</a>() : <a name="l00057"></a>00057 <a class="code" href="structusrp2_1_1tx__metadata.html#ac9383e8f117c1ab8360f97a22e78bf5f">timestamp</a>(0), <a class="code" href="structusrp2_1_1tx__metadata.html#a20c9f34fc7b31f6a7c69195e661593f0">send_now</a>(0), <a class="code" href="structusrp2_1_1tx__metadata.html#ae81dd42d707b24aa3b4fc7ab7dc73778">start_of_burst</a>(0), <a class="code" href="structusrp2_1_1tx__metadata.html#afc2a15efbafed55ba70474e43a7075eb">end_of_burst</a>(0) {} <a name="l00058"></a>00058 }; <a name="l00059"></a>00059 <a name="l00060"></a>00060 }; <span class="comment">// usrp2</span> <a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_USRP2_METADATA_H */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="metadata_8h.html">metadata.h</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>