GNU Radio 3.7.2 C++ API
simple_squelch_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H
24 #define INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace analog {
31 
32  /*!
33  * \brief simple squelch block based on average signal power and threshold in dB.
34  * \ingroup level_controllers_blk
35  */
36  class ANALOG_API simple_squelch_cc : virtual public sync_block
37  {
38  public:
39  // gr::analog::simple_squelch_cc::sptr
41 
42  /*!
43  * \brief Make a simple squelch block.
44  *
45  * \param threshold_db Threshold for muting.
46  * \param alpha Gain parameter for the running average filter.
47  */
48  static sptr make(double threshold_db, double alpha);
49 
50  virtual bool unmuted() const = 0;
51 
52  virtual void set_alpha(double alpha) = 0;
53  virtual void set_threshold(double decibels) = 0;
54 
55  virtual double threshold() const = 0;
56  virtual std::vector<float> squelch_range() const = 0;
57  };
58 
59  } /* namespace analog */
60 } /* namespace gr */
61 
62 #endif /* INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H */
simple squelch block based on average signal power and threshold in dB.
Definition: simple_squelch_cc.h:36
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< simple_squelch_cc > sptr
Definition: simple_squelch_cc.h:40
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30