<!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: rx_sample_handler.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('rx__sample__handler_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>rx_sample_handler.h</h1> </div> </div> <div class="contents"> <a href="rx__sample__handler_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_RX_SAMPLE_HANDLER_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_USRP2_RX_SAMPLE_HANDLER_H</span> <a name="l00020"></a>00020 <span class="preprocessor"></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <usrp2/metadata.h></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <stddef.h></span> <a name="l00023"></a>00023 <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="keyword">namespace </span>usrp2 { <a name="l00026"></a>00026 <span class="comment"></span> <a name="l00027"></a>00027 <span class="comment"> /*!</span> <a name="l00028"></a>00028 <span class="comment"> * \brief Abstract function object called to handle received data blocks.</span> <a name="l00029"></a>00029 <span class="comment"> * \ingroup usrp2</span> <a name="l00030"></a>00030 <span class="comment"> *</span> <a name="l00031"></a>00031 <span class="comment"> * An object derived from this class is passed to usrp2::rx_samples</span> <a name="l00032"></a>00032 <span class="comment"> * to process the received frames of samples.</span> <a name="l00033"></a>00033 <span class="comment"> */</span> <a name="l00034"></a><a class="code" href="classusrp2_1_1rx__sample__handler.html">00034</a> <span class="keyword">class </span><a class="code" href="classusrp2_1_1rx__sample__handler.html" title="Abstract function object called to handle received data blocks.An object derived from this class is p...">rx_sample_handler</a> { <a name="l00035"></a>00035 <span class="keyword">public</span>: <a name="l00036"></a>00036 <span class="keyword">virtual</span> <a class="code" href="classusrp2_1_1rx__sample__handler.html#a014d9cd0873e8da27a952ffa756a96b9">~rx_sample_handler</a>(); <a name="l00037"></a>00037 <span class="comment"></span> <a name="l00038"></a>00038 <span class="comment"> /*!</span> <a name="l00039"></a>00039 <span class="comment"> * \param items points to the first 32-bit word of uninterpreted sample data in the frame.</span> <a name="l00040"></a>00040 <span class="comment"> * \param nitems is the number of entries in the frame in units of uint32_t's.</span> <a name="l00041"></a>00041 <span class="comment"> * \param metadata is the additional per frame data provided by the USRP2 FPGA.</span> <a name="l00042"></a>00042 <span class="comment"> *</span> <a name="l00043"></a>00043 <span class="comment"> * \p items points to the raw sample data received off of the ethernet. The data is</span> <a name="l00044"></a>00044 <span class="comment"> * packed into big-endian 32-bit unsigned ints for transport, but the actual format</span> <a name="l00045"></a>00045 <span class="comment"> * of the data is dependent on the current configuration of the USRP2. The most common</span> <a name="l00046"></a>00046 <span class="comment"> * format is 16-bit I & Q, with I in the top of the 32-bit word.</span> <a name="l00047"></a>00047 <span class="comment"> *</span> <a name="l00048"></a>00048 <span class="comment"> * This is the general purpose, low level interface and relies on other functions</span> <a name="l00049"></a>00049 <span class="comment"> * to handle all required endian-swapping and format conversion. \sa FIXME.</span> <a name="l00050"></a>00050 <span class="comment"> *</span> <a name="l00051"></a>00051 <span class="comment"> * \returns true if the object wants to be called again with new data;</span> <a name="l00052"></a>00052 <span class="comment"> * false if no additional data is wanted.</span> <a name="l00053"></a>00053 <span class="comment"> */</span> <a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1rx__sample__handler.html#a6f603e963d9bc69ee5c8bb9ae79d9192">operator()</a>(<span class="keyword">const</span> uint32_t *items, <span class="keywordtype">size_t</span> nitems, <span class="keyword">const</span> <a class="code" href="structusrp2_1_1rx__metadata.html" title="metadata associated with received frames">rx_metadata</a> *metadata) = 0; <a name="l00055"></a>00055 }; <a name="l00056"></a>00056 <a name="l00057"></a>00057 }; <a name="l00058"></a>00058 <a name="l00059"></a>00059 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_RX_SAMPLE_HANDLER_H */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="rx__sample__handler_8h.html">rx_sample_handler.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>