GNU Radio 3.6.5 C++ API

simple_squelch_cc.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H
00024 #define INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H
00025 
00026 #include <analog/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace analog {
00031     
00032     /*!
00033      * \brief simple squelch block based on average signal power and threshold in dB.
00034      * \ingroup level_controllers_blk
00035      */
00036     class ANALOG_API simple_squelch_cc : virtual public gr_sync_block
00037     {
00038     public:
00039       // gr::analog::simple_squelch_cc::sptr
00040       typedef boost::shared_ptr<simple_squelch_cc> sptr;
00041 
00042       /*!
00043        * \brief Make a simple squelch block.
00044        *
00045        * \param threshold_db Threshold for muting.
00046        * \param alpha Gain parameter for the running average filter.
00047        */
00048       static sptr make(double threshold_db, double alpha);
00049 
00050       virtual bool unmuted() const  = 0;
00051 
00052       virtual void set_alpha(double alpha) = 0;
00053       virtual void set_threshold(double decibels) = 0;
00054 
00055       virtual double threshold() const = 0;
00056       virtual std::vector<float> squelch_range() const = 0;
00057     };
00058 
00059   } /* namespace analog */
00060 } /* namespace gr */
00061 
00062 #endif /* INCLUDED_ANALOG_SIMPLE_SQUELCH_CC_H */