<!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.3.0 C++ API: rx_16sc_handler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>rx_16sc_handler Class Reference</h1><!-- doxytag: class="rx_16sc_handler" --><!-- doxytag: inherits="usrp2::rx_nop_handler" -->
<p><code>#include <<a class="el" href="rx__16sc__handler_8h_source.html">rx_16sc_handler.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for rx_16sc_handler:</div>
<div class="dynsection">
<div class="center"><img src="classrx__16sc__handler__inherit__graph.png" border="0" usemap="#rx__16sc__handler_inherit__map" alt="Inheritance graph"/></div>
<map name="rx__16sc__handler_inherit__map" id="rx__16sc__handler_inherit__map">
<area shape="rect" id="node2" href="classusrp2_1_1rx__nop__handler.html" title="usrp2::rx_nop_handler" alt="" coords="16,83,165,112"/><area shape="rect" id="node4" href="classusrp2_1_1rx__sample__handler.html" title="Abstract function object called to handle received data blocks.An object derived..." alt="" coords="5,5,176,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classrx__16sc__handler-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><br class="typebreak"/>
< <a class="el" href="classrx__16sc__handler.html">rx_16sc_handler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrx__16sc__handler.html#ad0d74dd4756abee956d66945334befd5">sptr</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrx__16sc__handler.html#aa64777749da89a212b1e07d96c5e44fb">operator()</a> (const uint32_t *items, size_t nitems, const <a class="el" href="structusrp2_1_1rx__metadata.html">usrp2::rx_metadata</a> *metadata)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrx__16sc__handler.html#a7d10ed4ee290250526b4aea37fb78a30">~rx_16sc_handler</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1shared__ptr.html">sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrx__16sc__handler.html#af1568521f7705126c00759462a0d805a">make</a> (uint64_t max_samples, uint64_t max_quantum, std::complex< int16_t > *dest)</td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="ad0d74dd4756abee956d66945334befd5"></a><!-- doxytag: member="rx_16sc_handler::sptr" ref="ad0d74dd4756abee956d66945334befd5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><<a class="el" href="classrx__16sc__handler.html">rx_16sc_handler</a>> <a class="el" href="classboost_1_1shared__ptr.html">rx_16sc_handler::sptr</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classusrp2_1_1rx__nop__handler.html#ab759acd1b6667096023c459c868e149e">usrp2::rx_nop_handler</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7d10ed4ee290250526b4aea37fb78a30"></a><!-- doxytag: member="rx_16sc_handler::~rx_16sc_handler" ref="a7d10ed4ee290250526b4aea37fb78a30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rx_16sc_handler::~rx_16sc_handler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af1568521f7705126c00759462a0d805a"></a><!-- doxytag: member="rx_16sc_handler::make" ref="af1568521f7705126c00759462a0d805a" args="(uint64_t max_samples, uint64_t max_quantum, std::complex< int16_t > *dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classboost_1_1shared__ptr.html">sptr</a> rx_16sc_handler::make </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"> <em>max_samples</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"> <em>max_quantum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::complex< int16_t > * </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa64777749da89a212b1e07d96c5e44fb"></a><!-- doxytag: member="rx_16sc_handler::operator()" ref="aa64777749da89a212b1e07d96c5e44fb" args="(const uint32_t *items, size_t nitems, const usrp2::rx_metadata *metadata)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> rx_16sc_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">usrp2::rx_metadata</a> * </td>
<td class="paramname"> <em>metadata</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function operator invoked by USRP2 RX API. Derived classes must override this method but then invoke it at the start of their processing. This operator will always be called at least once.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>items</em> </td><td>points to the first 32-bit word of uninterpreted sample data in the frame. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nitems</em> </td><td>is the number of entries in the frame in units of uint32_t's. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>metadata</em> </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>
<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>Reimplemented from <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__16sc__handler_8h_source.html">rx_16sc_handler.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:01 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
