<!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: usrp2::rx_sample_handler Class Reference</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('classusrp2_1_1rx__sample__handler.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>usrp2::rx_sample_handler Class Reference<div class="ingroups"><a class="el" href="group__usrp2.html">USRP2</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="usrp2::rx_sample_handler" -->
<p>Abstract function object called to handle received data blocks.An object derived from this class is passed to <a class="el" href="classusrp2_1_1usrp2.html#adc5c23804bb1277b89ec51c519275c42" title="Receive data from the specified channel This method is used to receive all data: streaming or discret...">usrp2::rx_samples</a> to process the received frames of samples.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="rx__sample__handler_8h_source.html">rx_sample_handler.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for usrp2::rx_sample_handler:</div>
<div class="dyncontent">
<div class="center"><img src="classusrp2_1_1rx__sample__handler__inherit__graph.png" border="0" usemap="#usrp2_1_1rx__sample__handler_inherit__map" alt="Inheritance graph"/></div>
<map name="usrp2_1_1rx__sample__handler_inherit__map" id="usrp2_1_1rx__sample__handler_inherit__map">
<area shape="rect" id="node3" href="classusrp2_1_1rx__nop__handler.html" title="usrp2::rx_nop_handler" alt="" coords="59,83,208,112"/><area shape="rect" id="node5" href="classrx__16sc__handler.html" title="rx_16sc_handler" alt="" coords="5,160,123,189"/><area shape="rect" id="node7" href="classrx__32fc__handler.html" title="rx_32fc_handler" alt="" coords="147,160,261,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classusrp2_1_1rx__sample__handler-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1rx__sample__handler.html#a014d9cd0873e8da27a952ffa756a96b9">~rx_sample_handler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2_1_1rx__sample__handler.html#a6f603e963d9bc69ee5c8bb9ae79d9192">operator()</a> (const uint32_t *items, size_t nitems, const <a class="el" href="structusrp2_1_1rx__metadata.html">rx_metadata</a> *metadata)=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract function object called to handle received data blocks.</p>
<p>An object derived from this class is passed to <a class="el" href="classusrp2_1_1usrp2.html#adc5c23804bb1277b89ec51c519275c42" title="Receive data from the specified channel This method is used to receive all data: streaming or discret...">usrp2::rx_samples</a> to process the received frames of samples. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a014d9cd0873e8da27a952ffa756a96b9"></a><!-- doxytag: member="usrp2::rx_sample_handler::~rx_sample_handler" ref="a014d9cd0873e8da27a952ffa756a96b9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual usrp2::rx_sample_handler::~rx_sample_handler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6f603e963d9bc69ee5c8bb9ae79d9192"></a><!-- doxytag: member="usrp2::rx_sample_handler::operator()" ref="a6f603e963d9bc69ee5c8bb9ae79d9192" args="(const uint32_t *items, size_t nitems, const rx_metadata *metadata)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2::rx_sample_handler::operator() </td>
<td>(</td>
<td class="paramtype">const uint32_t * </td>
<td class="paramname"><em>items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structusrp2_1_1rx__metadata.html">rx_metadata</a> * </td>
<td class="paramname"><em>metadata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">items</td><td>points to the first 32-bit word of uninterpreted sample data in the frame. </td></tr>
<tr><td class="paramname">nitems</td><td>is the number of entries in the frame in units of uint32_t's. </td></tr>
<tr><td class="paramname">metadata</td><td>is the additional per frame data provided by the USRP2 FPGA.</td></tr>
</table>
</dd>
</dl>
<p><code>items</code> points to the raw sample data received off of the ethernet. The data is packed into big-endian 32-bit unsigned ints for transport, but the actual format of the data is dependent on the current configuration of the USRP2. The most common format is 16-bit I & Q, with I in the top of the 32-bit word.</p>
<p>This is the general purpose, low level interface and relies on other functions to handle all required endian-swapping and format conversion. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>FIXME.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the object wants to be called again with new data; false if no additional data is wanted. </dd></dl>
<p>Implemented in <a class="el" href="classrx__16sc__handler.html#aa64777749da89a212b1e07d96c5e44fb">rx_16sc_handler</a>, <a class="el" href="classrx__32fc__handler.html#a47e45988d2ca67fefcf9cb0aaffab2f7">rx_32fc_handler</a>, and <a class="el" href="classusrp2_1_1rx__nop__handler.html#aa274f87d6c1d8de9dc412e9c00b4d955">usrp2::rx_nop_handler</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rx__sample__handler_8h_source.html">rx_sample_handler.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>usrp2</b> </li>
<li class="navelem"><a class="el" href="classusrp2_1_1rx__sample__handler.html">rx_sample_handler</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
>
2931
