<!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: gr_squelch_base_ff 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('classgr__squelch__base__ff.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>gr_squelch_base_ff Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_squelch_base_ff" --><!-- doxytag: inherits="gr_block" -->
<p><code>#include <<a class="el" href="gr__squelch__base__ff_8h_source.html">gr_squelch_base_ff.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_squelch_base_ff:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__squelch__base__ff__inherit__graph.png" border="0" usemap="#gr__squelch__base__ff_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__squelch__base__ff_inherit__map" id="gr__squelch__base__ff_inherit__map">
<area shape="rect" id="node7" href="classgr__ctcss__squelch__ff.html" title="gate or zero output if ctcss tone not present" alt="" coords="5,237,144,267"/><area shape="rect" id="node9" href="classgr__pwr__squelch__ff.html" title="gate or zero output when input power below threshold" alt="" coords="168,237,296,267"/><area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="119,83,188,112"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="99,5,208,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__squelch__base__ff-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#ac34fcf7e0e58556662f3d723a54fc07c">gr_squelch_base_ff</a> (const char *name, int ramp, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gate)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#ac2f3750d222001ce567cd0a98aac1f42">ramp</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#af132863176c3cd8e2d3fd93563efc30c">set_ramp</a> (int ramp)</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="classgr__squelch__base__ff.html#a3a355b937004b1591ea4cd7e6f350f01">gate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#ade94673ea332fa0e5ad10b29569a313b">set_gate</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gate)</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="classgr__squelch__base__ff.html#a05964b8dc3b4292743e5f8ef080858c5">unmuted</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstd_1_1vector.html">std::vector</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#a2e51b381d993274ec398cda51906a5e3">squelch_range</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#a578e533e62aa8293ae9944d33e1e16f4">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_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">compute output items from input items <a href="#a578e533e62aa8293ae9944d33e1e16f4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__squelch__base__ff.html#aa9108138b750f1ebbd8c6a09f5b47e00">update_state</a> (const float &sample)</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="classgr__squelch__base__ff.html#aea375a4e3979b65149255ceed271e108">mute</a> () const </td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac34fcf7e0e58556662f3d723a54fc07c"></a><!-- doxytag: member="gr_squelch_base_ff::gr_squelch_base_ff" ref="ac34fcf7e0e58556662f3d723a54fc07c" args="(const char *name, int ramp, bool gate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_squelch_base_ff::gr_squelch_base_ff </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">int </td>
<td class="paramname"><em>ramp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>gate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a355b937004b1591ea4cd7e6f350f01"></a><!-- doxytag: member="gr_squelch_base_ff::gate" ref="a3a355b937004b1591ea4cd7e6f350f01" args="() 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> gr_squelch_base_ff::gate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__squelch__base__ff.html#ade94673ea332fa0e5ad10b29569a313b">set_gate()</a>.</p>
</div>
</div>
<a class="anchor" id="a578e533e62aa8293ae9944d33e1e16f4"></a><!-- doxytag: member="gr_squelch_base_ff::general_work" ref="a578e533e62aa8293ae9944d33e1e16f4" args="(int noutput_items, gr_vector_int &ninput_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_squelch_base_ff::general_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_int</a> & </td>
<td class="paramname"><em>ninput_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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compute output items from input items </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">noutput_items</td><td>number of output items to write on each output stream </td></tr>
<tr><td class="paramname">ninput_items</td><td>number of input items available on each input stream </td></tr>
<tr><td class="paramname">input_items</td><td>vector of pointers to the input items, one entry per input stream </td></tr>
<tr><td class="paramname">output_items</td><td>vector of pointers to the output items, one entry per output stream</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</dd></dl>
<p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p>
<p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="aea375a4e3979b65149255ceed271e108"></a><!-- doxytag: member="gr_squelch_base_ff::mute" ref="aea375a4e3979b65149255ceed271e108" args="() const " -->
<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> gr_squelch_base_ff::mute </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classgr__ctcss__squelch__ff.html#aa1819609522061104cffd2e5efde2ff3">gr_ctcss_squelch_ff</a>, and <a class="el" href="classgr__pwr__squelch__ff.html#aa624cf99e3b6c45b894524b0e3f00530">gr_pwr_squelch_ff</a>.</p>
</div>
</div>
<a class="anchor" id="ac2f3750d222001ce567cd0a98aac1f42"></a><!-- doxytag: member="gr_squelch_base_ff::ramp" ref="ac2f3750d222001ce567cd0a98aac1f42" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_squelch_base_ff::ramp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__squelch__base__ff.html#af132863176c3cd8e2d3fd93563efc30c">set_ramp()</a>.</p>
</div>
</div>
<a class="anchor" id="ade94673ea332fa0e5ad10b29569a313b"></a><!-- doxytag: member="gr_squelch_base_ff::set_gate" ref="ade94673ea332fa0e5ad10b29569a313b" args="(bool gate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_squelch_base_ff::set_gate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>gate</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__squelch__base__ff.html#a3a355b937004b1591ea4cd7e6f350f01">gate()</a>.</p>
</div>
</div>
<a class="anchor" id="af132863176c3cd8e2d3fd93563efc30c"></a><!-- doxytag: member="gr_squelch_base_ff::set_ramp" ref="af132863176c3cd8e2d3fd93563efc30c" args="(int ramp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_squelch_base_ff::set_ramp </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ramp</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__squelch__base__ff.html#ac2f3750d222001ce567cd0a98aac1f42">ramp()</a>.</p>
</div>
</div>
<a class="anchor" id="a2e51b381d993274ec398cda51906a5e3"></a><!-- doxytag: member="gr_squelch_base_ff::squelch_range" ref="a2e51b381d993274ec398cda51906a5e3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstd_1_1vector.html">std::vector</a><float> gr_squelch_base_ff::squelch_range </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classgr__ctcss__squelch__ff.html#a133380235e76cf3043f50bd80a1cb663">gr_ctcss_squelch_ff</a>, and <a class="el" href="classgr__pwr__squelch__ff.html#a21ef3df4e480010e2e92020a352ff441">gr_pwr_squelch_ff</a>.</p>
</div>
</div>
<a class="anchor" id="a05964b8dc3b4292743e5f8ef080858c5"></a><!-- doxytag: member="gr_squelch_base_ff::unmuted" ref="a05964b8dc3b4292743e5f8ef080858c5" args="() 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> gr_squelch_base_ff::unmuted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa9108138b750f1ebbd8c6a09f5b47e00"></a><!-- doxytag: member="gr_squelch_base_ff::update_state" ref="aa9108138b750f1ebbd8c6a09f5b47e00" args="(const float &sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_squelch_base_ff::update_state </td>
<td>(</td>
<td class="paramtype">const float & </td>
<td class="paramname"><em>sample</em></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classgr__ctcss__squelch__ff.html#a5437e033ee9e42874cf16e751a73ff78">gr_ctcss_squelch_ff</a>, and <a class="el" href="classgr__pwr__squelch__ff.html#a30c140dc3446051aa19defcf0994a1f6">gr_pwr_squelch_ff</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__squelch__base__ff_8h_source.html">gr_squelch_base_ff.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__squelch__base__ff.html">gr_squelch_base_ff</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
>
2017
