<!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: usrp2_base 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>usrp2_base Class Reference</h1><!-- doxytag: class="usrp2_base" --><!-- doxytag: inherits="gr_sync_block" -->
<p><code>#include <<a class="el" href="usrp2__base_8h_source.html">usrp2_base.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for usrp2_base:</div>
<div class="dynsection">
<div class="center"><img src="classusrp2__base__inherit__graph.png" border="0" usemap="#usrp2__base_inherit__map" alt="Inheritance graph"/></div>
<map name="usrp2__base_inherit__map" id="usrp2__base_inherit__map">
<area shape="rect" id="node13" href="classusrp2__sink__base.html" title="usrp2_sink_base" alt="" coords="147,469,267,499"/><area shape="rect" id="node19" href="classusrp2__source__base.html" title="usrp2_source_base" alt="" coords="291,469,424,499"/><area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="228,315,335,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="247,237,316,267"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="227,160,336,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="220,83,343,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="212,5,351,35"/><area shape="rect" id="node15" href="classusrp2__sink__16sc.html" title="usrp2_sink_16sc" alt="" coords="5,547,125,576"/><area shape="rect" id="node17" href="classusrp2__sink__32fc.html" title="usrp2_sink_32fc" alt="" coords="149,547,267,576"/><area shape="rect" id="node21" href="classusrp2__source__16sc.html" title="usrp2_source_16sc" alt="" coords="291,547,424,576"/><area shape="rect" id="node23" href="classusrp2__source__32fc.html" title="usrp2_source_32fc" alt="" coords="448,547,579,576"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classusrp2__base-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#a159a4198dc8ae413404f14c101af9d5e">~usrp2_base</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#aa80f40999e5a4bd008331ecf98fe635b">mac_addr</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get USRP2 hardware MAC address. <a href="#aa80f40999e5a4bd008331ecf98fe635b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#a2068b65254153051e48227726f99d376">interface_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get interface name used to communicat with USRP2. <a href="#a2068b65254153051e48227726f99d376"></a><br/></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="classusrp2__base.html#aeb6f787e406c46f4953bdbaf23f23937">fpga_master_clock_freq</a> (long *freq) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get USRP2 master clock rate. <a href="#aeb6f787e406c46f4953bdbaf23f23937"></a><br/></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="classusrp2__base.html#a64b8af14f2a15d4c8c02ebc0c0ad38ba">config_mimo</a> (int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">MIMO configuration. <a href="#a64b8af14f2a15d4c8c02ebc0c0ad38ba"></a><br/></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="classusrp2__base.html#a6c8abac86ef5d8b0815e892980d14e3f">sync_to_pps</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set master time to 0 at next PPS rising edge. <a href="#a6c8abac86ef5d8b0815e892980d14e3f"></a><br/></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="classusrp2__base.html#ac8225ecb6bec4e1256e7db7516f42c79">sync_every_pps</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>< uint32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#a957ee3d7cea7c05476036e4d714646fd">peek32</a> (uint32_t addr, uint32_t words)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read memory from Wishbone bus as words. <a href="#a957ee3d7cea7c05476036e4d714646fd"></a><br/></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="classusrp2__base.html#a29a88baa072e1c35e77d715543474aa3">poke32</a> (uint32_t addr, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< uint32_t > &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write memory to Wishbone bus as words. <a href="#a29a88baa072e1c35e77d715543474aa3"></a><br/></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__base.html#acba2abb76b13eaf7be15d787244bdf6b">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by scheduler when starting flowgraph. <a href="#acba2abb76b13eaf7be15d787244bdf6b"></a><br/></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__base.html#a7f92359dc1760ac40f201da01886b14f">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by scheduler when stopping flowgraph. <a href="#a7f92359dc1760ac40f201da01886b14f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#ab1cd79d541b22ec545e75f3c37956858">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived class must override this. <a href="#ab1cd79d541b22ec545e75f3c37956858"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#a14b16d411557ca85c86e98103a897639">usrp2_base</a> (const char *name, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> input_signature, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> output_signature, const std::string &ifc, const std::string &mac) throw (std::runtime_error)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">usrp2::usrp2::sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classusrp2__base.html#a49c7166ecd4154f69f059c6c6ab18569">d_u2</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for all USRP2 blocks </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a14b16d411557ca85c86e98103a897639"></a><!-- doxytag: member="usrp2_base::usrp2_base" ref="a14b16d411557ca85c86e98103a897639" args="(const char *name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature, const std::string &ifc, const std::string &mac)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp2_base::usrp2_base </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"> <em>input_signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"> <em>output_signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>ifc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>mac</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw (std::runtime_error)<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a159a4198dc8ae413404f14c101af9d5e"></a><!-- doxytag: member="usrp2_base::~usrp2_base" ref="a159a4198dc8ae413404f14c101af9d5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">usrp2_base::~usrp2_base </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="a64b8af14f2a15d4c8c02ebc0c0ad38ba"></a><!-- doxytag: member="usrp2_base::config_mimo" ref="a64b8af14f2a15d4c8c02ebc0c0ad38ba" args="(int flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2_base::config_mimo </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>MIMO configuration. </p>
</div>
</div>
<a class="anchor" id="aeb6f787e406c46f4953bdbaf23f23937"></a><!-- doxytag: member="usrp2_base::fpga_master_clock_freq" ref="aeb6f787e406c46f4953bdbaf23f23937" args="(long *freq) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2_base::fpga_master_clock_freq </td>
<td>(</td>
<td class="paramtype">long * </td>
<td class="paramname"> <em>freq</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get USRP2 master clock rate. </p>
</div>
</div>
<a class="anchor" id="a2068b65254153051e48227726f99d376"></a><!-- doxytag: member="usrp2_base::interface_name" ref="a2068b65254153051e48227726f99d376" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string usrp2_base::interface_name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get interface name used to communicat with USRP2. </p>
</div>
</div>
<a class="anchor" id="aa80f40999e5a4bd008331ecf98fe635b"></a><!-- doxytag: member="usrp2_base::mac_addr" ref="aa80f40999e5a4bd008331ecf98fe635b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string usrp2_base::mac_addr </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get USRP2 hardware MAC address. </p>
</div>
</div>
<a class="anchor" id="a957ee3d7cea7c05476036e4d714646fd"></a><!-- doxytag: member="usrp2_base::peek32" ref="a957ee3d7cea7c05476036e4d714646fd" args="(uint32_t addr, uint32_t words)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a><uint32_t> usrp2_base::peek32 </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>words</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read memory from Wishbone bus as words. </p>
</div>
</div>
<a class="anchor" id="a29a88baa072e1c35e77d715543474aa3"></a><!-- doxytag: member="usrp2_base::poke32" ref="a29a88baa072e1c35e77d715543474aa3" args="(uint32_t addr, const std::vector< uint32_t > &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2_base::poke32 </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< uint32_t > & </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write memory to Wishbone bus as words. </p>
</div>
</div>
<a class="anchor" id="acba2abb76b13eaf7be15d787244bdf6b"></a><!-- doxytag: member="usrp2_base::start" ref="acba2abb76b13eaf7be15d787244bdf6b" args="()" -->
<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_base::start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called by scheduler when starting flowgraph. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a49ea94a86f3199f23563bb837633ea1f">gr_block</a>.</p>
<p>Reimplemented in <a class="el" href="classusrp2__source__base.html#a8283ff40606ce6fc239a0cf52a67cfa4">usrp2_source_base</a>.</p>
</div>
</div>
<a class="anchor" id="a7f92359dc1760ac40f201da01886b14f"></a><!-- doxytag: member="usrp2_base::stop" ref="a7f92359dc1760ac40f201da01886b14f" args="()" -->
<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_base::stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called by scheduler when stopping flowgraph. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a53c2c89c037e4e393b75414d605e36b1">gr_block</a>.</p>
<p>Reimplemented in <a class="el" href="classusrp2__source__base.html#adea8505626b80ad87a5ad4092b2a639a">usrp2_source_base</a>.</p>
</div>
</div>
<a class="anchor" id="ac8225ecb6bec4e1256e7db7516f42c79"></a><!-- doxytag: member="usrp2_base::sync_every_pps" ref="ac8225ecb6bec4e1256e7db7516f42c79" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2_base::sync_every_pps </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset master time to 0 at every PPS edge </p>
</div>
</div>
<a class="anchor" id="a6c8abac86ef5d8b0815e892980d14e3f"></a><!-- doxytag: member="usrp2_base::sync_to_pps" ref="a6c8abac86ef5d8b0815e892980d14e3f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> usrp2_base::sync_to_pps </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set master time to 0 at next PPS rising edge. </p>
</div>
</div>
<a class="anchor" id="ab1cd79d541b22ec545e75f3c37956858"></a><!-- doxytag: member="usrp2_base::work" ref="ab1cd79d541b22ec545e75f3c37956858" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int usrp2_base::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Derived class must override this. </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
<p>Implemented in <a class="el" href="classusrp2__sink__16sc.html#a95f9d032ccc5eb51a38cc439eb2d026f">usrp2_sink_16sc</a>, <a class="el" href="classusrp2__sink__32fc.html#a41272912244a1fc0c94456c89fb75112">usrp2_sink_32fc</a>, <a class="el" href="classusrp2__source__16sc.html#a129738226df66e550eb8556a418bcc9b">usrp2_source_16sc</a>, and <a class="el" href="classusrp2__source__32fc.html#ab0770cbc1a4a800ea2f01fbd1a2656ff">usrp2_source_32fc</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a49c7166ecd4154f69f059c6c6ab18569"></a><!-- doxytag: member="usrp2_base::d_u2" ref="a49c7166ecd4154f69f059c6c6ab18569" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">usrp2::usrp2::sptr</a> <a class="el" href="classusrp2__base.html#a49c7166ecd4154f69f059c6c6ab18569">usrp2_base::d_u2</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="usrp2__base_8h_source.html">usrp2_base.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:53:03 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>
