<!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: gr_throttle 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>gr_throttle Class Reference<br/>
<small>
[<a class="el" href="group__misc__blk.html">Miscellaneous Blocks</a>]</small>
</h1><!-- doxytag: class="gr_throttle" --><!-- doxytag: inherits="gr_sync_block" -->
<p>throttle flow of samples such that the average rate does not exceed samples_per_sec.input: one stream of itemsize; output: one stream of itemsize
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__throttle_8h_source.html">gr_throttle.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_throttle:</div>
<div class="dynsection">
<div class="center"><img src="classgr__throttle__inherit__graph.png" border="0" usemap="#gr__throttle_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__throttle_inherit__map" id="gr__throttle_inherit__map">
<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="21,315,128,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="40,237,109,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="20,160,129,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="13,83,136,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__throttle-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="classgr__throttle.html#a8885c3c6ab6d7a53b348792efb0b3c5e">~gr_throttle</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__throttle.html#a7f01eee4ac1c7d70592118a7f19853ec">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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a7f01eee4ac1c7d70592118a7f19853ec"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_throttle_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__throttle.html#a863d28356ce4fe780cc43fa9a30ec8a7">gr_make_throttle</a> (size_t itemsize, double samples_per_sec)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>throttle flow of samples such that the average rate does not exceed samples_per_sec.</p>
<p>input: one stream of itemsize; output: one stream of itemsize </p>
<p>N.B. this should only be used in GUI apps where there is no other rate limiting block. It is not intended nor effective at precisely controlling the rate of samples. That should be controlled by a source or sink tied to sample clock. E.g., a USRP or audio card. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8885c3c6ab6d7a53b348792efb0b3c5e"></a><!-- doxytag: member="gr_throttle::~gr_throttle" ref="a8885c3c6ab6d7a53b348792efb0b3c5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_throttle::~gr_throttle </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="a7f01eee4ac1c7d70592118a7f19853ec"></a><!-- doxytag: member="gr_throttle::work" ref="a7f01eee4ac1c7d70592118a7f19853ec" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_throttle::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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a863d28356ce4fe780cc43fa9a30ec8a7"></a><!-- doxytag: member="gr_throttle::gr_make_throttle" ref="a863d28356ce4fe780cc43fa9a30ec8a7" args="(size_t itemsize, double samples_per_sec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_throttle_sptr</a> gr_make_throttle </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>samples_per_sec</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</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="gr__throttle_8h_source.html">gr_throttle.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:57 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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
def0228095a1541e2d3632b6b6da7c38
>
files
>
2627
