GNU Radio 3.7.1 C++ API
pwr_squelch_ff.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,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_PWR_SQUELCH_FF_H
00024 #define INCLUDED_ANALOG_PWR_SQUELCH_FF_H
00025 
00026 #include <gnuradio/analog/api.h>
00027 #include <gnuradio/analog/squelch_base_ff.h>
00028 #include <cmath>
00029 
00030 namespace gr {
00031   namespace analog {
00032     
00033     /*!
00034      * \brief gate or zero output when input power below threshold
00035      * \ingroup level_controllers_blk
00036      */
00037     class ANALOG_API pwr_squelch_ff :
00038       public squelch_base_ff, virtual public block
00039     {
00040     protected:
00041       virtual void update_state(const float &in) = 0;
00042       virtual bool mute() const = 0;
00043 
00044     public:
00045       // gr::analog::pwr_squelch_ff::sptr
00046       typedef boost::shared_ptr<pwr_squelch_ff> sptr;
00047       
00048       /*!
00049        * \brief Make power-based squelch block.
00050        *
00051        * \param db threshold (in dB) for power squelch
00052        * \param alpha Gain of averaging filter
00053        * \param ramp sets response characteristic.
00054        * \param gate if true, no output if no squelch tone.
00055        *             if false, output 0's if no squelch tone.
00056        */
00057       static sptr make(double db, double alpha=0.0001,
00058                        int ramp=0, bool gate=false);
00059 
00060       virtual std::vector<float> squelch_range() const = 0;
00061 
00062       virtual double threshold() const = 0;
00063       virtual void set_threshold(double db) = 0;
00064       virtual void set_alpha(double alpha) = 0;
00065 
00066       virtual int ramp() const = 0;
00067       virtual void set_ramp(int ramp) = 0;
00068       virtual bool gate() const = 0;
00069       virtual void set_gate(bool gate) = 0;
00070       virtual bool unmuted() const = 0;
00071     };
00072 
00073   } /* namespace analog */
00074 } /* namespace gr */
00075 
00076 #endif /* INCLUDED_ANALOG_PWR_SQUELCH_FF_H */