GNU Radio 3.7.1 C++ API
agc3_cc.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_AGC3_CC_H
00024 #define INCLUDED_ANALOG_AGC3_CC_H
00025 
00026 #include <gnuradio/analog/api.h>
00027 #include <gnuradio/sync_block.h>
00028 
00029 namespace gr {
00030   namespace analog {
00031 
00032     /*!
00033      * \brief high performance Automatic Gain Control class with
00034      * attack and decay rates.
00035      * \ingroup level_controllers_blk
00036      *
00037      * \details
00038      * Unlike the AGC2 loop, this uses an initial linear calculation
00039      * at the beginning for very fast initial acquisition. Moves to
00040      * IIR model for tracking purposes.
00041      * 
00042      * For Power the absolute value of the complex number is used.
00043      */
00044     class ANALOG_API agc3_cc : virtual public sync_block
00045     {
00046     public:
00047       // gr::analog::agc3_cc::sptr
00048       typedef boost::shared_ptr<agc3_cc> sptr;
00049             
00050       /*!
00051        * Build a complex value AGC loop block with attack and decay rates.
00052        *
00053        * \param attack_rate the update rate of the loop when in attack mode.
00054        * \param decay_rate the update rate of the loop when in decay mode.
00055        * \param reference reference value to adjust signal power to.
00056        * \param gain initial gain value.
00057        */
00058       static sptr make(float attack_rate = 1e-1, float decay_rate = 1e-2,
00059                        float reference = 1.0, float gain = 1.0);
00060 
00061       virtual float attack_rate() const = 0;
00062       virtual float decay_rate() const = 0;
00063       virtual float reference() const = 0;
00064       virtual float gain() const = 0;
00065       virtual float max_gain() const = 0;
00066       
00067       virtual void set_attack_rate(float rate) = 0;
00068       virtual void set_decay_rate(float rate) = 0;
00069       virtual void set_reference(float reference) = 0;
00070       virtual void set_gain(float gain) = 0;
00071       virtual void set_max_gain(float max_gain) = 0;
00072     };
00073 
00074   } /* namespace analog */
00075 } /* namespace gr */
00076 
00077 #endif /* INCLUDED_ANALOG_AGC3_CC_H */