<!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_cc 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__cc.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_cc Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_squelch_base_cc" --><!-- doxytag: inherits="gr_block" -->
<p><code>#include <<a class="el" href="gr__squelch__base__cc_8h_source.html">gr_squelch_base_cc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_squelch_base_cc:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__squelch__base__cc__inherit__graph.png" border="0" usemap="#gr__squelch__base__cc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__squelch__base__cc_inherit__map" id="gr__squelch__base__cc_inherit__map">
<area shape="rect" id="node7" href="classgr__pwr__squelch__cc.html" title="gate or zero output when input power below threshold" alt="" coords="9,237,143,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="41,83,111,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="21,5,131,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__squelch__base__cc-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__cc.html#a88d6244e55ba1c0a0af750097ac9a2a3">gr_squelch_base_cc</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__cc.html#a75e246fbe7392ab6ada53fc7154a29b1">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__cc.html#a4fbf6731c6fc6f0768e395a7e57695f7">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__cc.html#aac453abc028ae38e941375e90c426d6d">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__cc.html#ab3de9b306f78de0ce46c736a33b9f50f">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__cc.html#aee62d8c2fa75b77d1e7580c28d999849">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__cc.html#aa057da566cf1cd38fb991f7bfa0e2a89">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__cc.html#a0b4c46b6b18b013fac914094b99e23d3">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="#a0b4c46b6b18b013fac914094b99e23d3"></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__cc.html#abfd6f465a2c52de7da1fe5e4293877dd">update_state</a> (const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> &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__cc.html#a0aed8cb09a725dedcdc69bb3b298f283">mute</a> () const </td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a88d6244e55ba1c0a0af750097ac9a2a3"></a><!-- doxytag: member="gr_squelch_base_cc::gr_squelch_base_cc" ref="a88d6244e55ba1c0a0af750097ac9a2a3" args="(const char *name, int ramp, bool gate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_squelch_base_cc::gr_squelch_base_cc </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="aac453abc028ae38e941375e90c426d6d"></a><!-- doxytag: member="gr_squelch_base_cc::gate" ref="aac453abc028ae38e941375e90c426d6d" 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_cc::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__cc.html#ab3de9b306f78de0ce46c736a33b9f50f">set_gate()</a>.</p>
</div>
</div>
<a class="anchor" id="a0b4c46b6b18b013fac914094b99e23d3"></a><!-- doxytag: member="gr_squelch_base_cc::general_work" ref="a0b4c46b6b18b013fac914094b99e23d3" 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_cc::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="a0aed8cb09a725dedcdc69bb3b298f283"></a><!-- doxytag: member="gr_squelch_base_cc::mute" ref="a0aed8cb09a725dedcdc69bb3b298f283" 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_cc::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__pwr__squelch__cc.html#a77a8947bcc06fb2051a9cf1d25193b5d">gr_pwr_squelch_cc</a>.</p>
</div>
</div>
<a class="anchor" id="a75e246fbe7392ab6ada53fc7154a29b1"></a><!-- doxytag: member="gr_squelch_base_cc::ramp" ref="a75e246fbe7392ab6ada53fc7154a29b1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_squelch_base_cc::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__cc.html#a4fbf6731c6fc6f0768e395a7e57695f7">set_ramp()</a>.</p>
</div>
</div>
<a class="anchor" id="ab3de9b306f78de0ce46c736a33b9f50f"></a><!-- doxytag: member="gr_squelch_base_cc::set_gate" ref="ab3de9b306f78de0ce46c736a33b9f50f" args="(bool gate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_squelch_base_cc::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__cc.html#aac453abc028ae38e941375e90c426d6d">gate()</a>.</p>
</div>
</div>
<a class="anchor" id="a4fbf6731c6fc6f0768e395a7e57695f7"></a><!-- doxytag: member="gr_squelch_base_cc::set_ramp" ref="a4fbf6731c6fc6f0768e395a7e57695f7" args="(int ramp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_squelch_base_cc::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__cc.html#a75e246fbe7392ab6ada53fc7154a29b1">ramp()</a>.</p>
</div>
</div>
<a class="anchor" id="aa057da566cf1cd38fb991f7bfa0e2a89"></a><!-- doxytag: member="gr_squelch_base_cc::squelch_range" ref="aa057da566cf1cd38fb991f7bfa0e2a89" 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_cc::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__pwr__squelch__cc.html#a1e897c3b5d3eb3d262c91746d625e243">gr_pwr_squelch_cc</a>.</p>
</div>
</div>
<a class="anchor" id="aee62d8c2fa75b77d1e7580c28d999849"></a><!-- doxytag: member="gr_squelch_base_cc::unmuted" ref="aee62d8c2fa75b77d1e7580c28d999849" 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_cc::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="abfd6f465a2c52de7da1fe5e4293877dd"></a><!-- doxytag: member="gr_squelch_base_cc::update_state" ref="abfd6f465a2c52de7da1fe5e4293877dd" args="(const gr_complex &sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_squelch_base_cc::update_state </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> & </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__pwr__squelch__cc.html#a79f6fb13cb0d93c2faf35f2b3879c8dd">gr_pwr_squelch_cc</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__cc_8h_source.html">gr_squelch_base_cc.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__squelch__base__cc.html">gr_squelch_base_cc</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
>
2012
