<!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_nop_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__nop__handler_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>rx_nop_handler.h</h1> </div>
</div>
<div class="contents">
<a href="rx__nop__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
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef INCLUDED_RX_NOP_HANDLER_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_RX_NOP_HANDLER_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <usrp2/rx_sample_handler.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">/*!</span>
<a name="l00026"></a>00026 <span class="comment"> * \ingroup usrp2</span>
<a name="l00027"></a>00027 <span class="comment"> *</span>
<a name="l00028"></a>00028 <span class="comment"> * Base class for receive handlers that must copy into potentially limited</span>
<a name="l00029"></a>00029 <span class="comment"> * range destination buffers.</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * Maintains counters for number of items copied, times invoked, and test</span>
<a name="l00032"></a>00032 <span class="comment"> * for whether maximum has been reached.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * Derived classes should override the () operator, but call this</span>
<a name="l00035"></a>00035 <span class="comment"> * parent class method at some point at the start of their own operations.</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">namespace </span>usrp2 {
<a name="l00039"></a>00039
<a name="l00040"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html">00040</a> <span class="keyword">class </span><a class="code" href="classusrp2_1_1rx__nop__handler.html">rx_nop_handler</a> : <span class="keyword">public</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="l00041"></a>00041 {
<a name="l00042"></a>00042 uint64_t d_max_samples;
<a name="l00043"></a>00043 uint64_t d_max_quantum;
<a name="l00044"></a>00044 uint64_t d_nsamples;
<a name="l00045"></a>00045 uint64_t d_nframes;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">protected</span>:
<a name="l00048"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a096e49b0d9e61cf9879dba483f90e1b5">00048</a> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a096e49b0d9e61cf9879dba483f90e1b5">d_err</a>;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">// Shared pointer to an instance of this class</span>
<a name="l00053"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#ab759acd1b6667096023c459c868e149e">00053</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<rx_nop_handler></a> <a class="code" href="classusrp2_1_1rx__nop__handler.html#ab759acd1b6667096023c459c868e149e">sptr</a>;
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /*!</span>
<a name="l00056"></a>00056 <span class="comment"> * Constructor</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * \param max_samples Maximum number of samples to copy. Use zero for no maximum.</span>
<a name="l00059"></a>00059 <span class="comment"> * \param max_quantum Maximum number of samples required to accept in one call.</span>
<a name="l00060"></a>00060 <span class="comment"> * Use 0 to indicate no maximum.</span>
<a name="l00061"></a>00061 <span class="comment"> */</span>
<a name="l00062"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a64b6247c33859a63ec52fa5099a42f27">00062</a> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a64b6247c33859a63ec52fa5099a42f27">rx_nop_handler</a>(uint64_t <a class="code" href="classusrp2_1_1rx__nop__handler.html#af33e3810d1ac4a5fa8d1af7ed2656d03" title="Returns maximum number of samples that will be copied.">max_samples</a>, uint64_t max_quantum=0)
<a name="l00063"></a>00063 : d_max_samples(max_samples), d_max_quantum(max_quantum),
<a name="l00064"></a>00064 d_nsamples(0), d_nframes(0), <a class="code" href="classusrp2_1_1rx__nop__handler.html#a096e49b0d9e61cf9879dba483f90e1b5">d_err</a>(<a class="code" href="gc__types_8h.html#a65e9886d74aaee76545e83dd09011727">false</a>) {}
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /*!</span>
<a name="l00067"></a>00067 <span class="comment"> * Destructor. Derived classes must implement their own, non-inline destructor.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069 <span class="keyword">virtual</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a1b266e1dde8c5edfb0075b46a014e9a7">~rx_nop_handler</a>();
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /*!</span>
<a name="l00072"></a>00072 <span class="comment"> * \brief Returns number of frames this copier was called with</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a3efeecc3974a7a4c925962d82da51ea8">00074</a> uint64_t <a class="code" href="classusrp2_1_1rx__nop__handler.html#a3efeecc3974a7a4c925962d82da51ea8" title="Returns number of frames this copier was called with.">nframes</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_nframes; }
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /*!</span>
<a name="l00077"></a>00077 <span class="comment"> * \brief Returns actual number of samples copied</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a2220061004f9e8b78103bfcce31b4407">00079</a> uint64_t <a class="code" href="classusrp2_1_1rx__nop__handler.html#a2220061004f9e8b78103bfcce31b4407" title="Returns actual number of samples copied.">nsamples</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_nsamples; }
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /*!</span>
<a name="l00082"></a>00082 <span class="comment"> * \brief Returns maximum number of samples that will be copied</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#af33e3810d1ac4a5fa8d1af7ed2656d03">00084</a> uint64_t <a class="code" href="classusrp2_1_1rx__nop__handler.html#af33e3810d1ac4a5fa8d1af7ed2656d03" title="Returns maximum number of samples that will be copied.">max_samples</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_max_samples; }
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /*!</span>
<a name="l00087"></a>00087 <span class="comment"> * Returns true if an error has occurred. Derived classes must set d_err to true</span>
<a name="l00088"></a>00088 <span class="comment"> * when an error occurs in the () operator</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a82c548ec3681324ae44d9b5e53186ed4">00090</a> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a82c548ec3681324ae44d9b5e53186ed4">has_errored_p</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a096e49b0d9e61cf9879dba483f90e1b5">d_err</a>; }
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /*!</span>
<a name="l00093"></a>00093 <span class="comment"> * \brief Returns true if this instance has reached the maximum number of samples</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#a1b4d4e698997a3ca9fd2fb9c71e93383">00095</a> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#a1b4d4e698997a3ca9fd2fb9c71e93383" title="Returns true if this instance has reached the maximum number of samples.">has_finished_p</a>()<span class="keyword"> const </span>
<a name="l00096"></a>00096 <span class="keyword"> </span>{ <span class="keywordflow">return</span> d_max_samples == 0 ? <span class="keyword">false</span> : d_nsamples >= d_max_samples-d_max_quantum; }
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /*!</span>
<a name="l00100"></a>00100 <span class="comment"> * Function operator invoked by USRP2 RX API. Derived classes must override this method</span>
<a name="l00101"></a>00101 <span class="comment"> * but then invoke it at the start of their processing. This operator will always be</span>
<a name="l00102"></a>00102 <span class="comment"> * called at least once.</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> * \param items points to the first 32-bit word of uninterpreted sample data in the frame.</span>
<a name="l00105"></a>00105 <span class="comment"> * \param nitems is the number of entries in the frame in units of uint32_t's.</span>
<a name="l00106"></a>00106 <span class="comment"> * \param metadata is the additional per frame data provided by the USRP2 FPGA.</span>
<a name="l00107"></a>00107 <span class="comment"> *</span>
<a name="l00108"></a>00108 <span class="comment"> * \p items points to the raw sample data received off of the ethernet. The data is</span>
<a name="l00109"></a>00109 <span class="comment"> * packed into big-endian 32-bit unsigned ints for transport, but the actual format</span>
<a name="l00110"></a>00110 <span class="comment"> * of the data is dependent on the current configuration of the USRP2. The most common</span>
<a name="l00111"></a>00111 <span class="comment"> * format is 16-bit I & Q, with I in the top of the 32-bit word.</span>
<a name="l00112"></a>00112 <span class="comment"> *</span>
<a name="l00113"></a>00113 <span class="comment"> * \returns true if the object wants to be called again with new data;</span>
<a name="l00114"></a>00114 <span class="comment"> * false if no additional data is wanted.</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a><a class="code" href="classusrp2_1_1rx__nop__handler.html#aa274f87d6c1d8de9dc412e9c00b4d955">00116</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classusrp2_1_1rx__nop__handler.html#aa274f87d6c1d8de9dc412e9c00b4d955">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)
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 <span class="comment">// printf("W0: %08x TS: %08x\n", metadata->word0, metadata->timestamp);</span>
<a name="l00119"></a>00119 <span class="comment">// printf("I0: %08x\n", items[0]);</span>
<a name="l00120"></a>00120
<a name="l00121"></a>00121 d_nsamples += nitems;
<a name="l00122"></a>00122 d_nframes++;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordflow">return</span> !<a class="code" href="classusrp2_1_1rx__nop__handler.html#a1b4d4e698997a3ca9fd2fb9c71e93383" title="Returns true if this instance has reached the maximum number of samples.">has_finished_p</a>();
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 };
<a name="l00127"></a>00127
<a name="l00128"></a>00128 } <span class="comment">/* namespace usrp2 */</span>
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_RX_NOP_HANDLER */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="rx__nop__handler_8h.html">rx_nop_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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
6829
