GNU Radio 3.6.5 C++ API

agc_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_AGC_CC_H
00024 #define INCLUDED_ANALOG_AGC_CC_H
00025 
00026 #include <analog/api.h>
00027 #include <analog/agc.h>
00028 #include <gr_sync_block.h>
00029 
00030 namespace gr {
00031   namespace analog {
00032 
00033     /*!
00034      * \brief high performance Automatic Gain Control class
00035      * \ingroup level_controllers_blk
00036      *
00037      * \details
00038      * For Power the absolute value of the complex number is used.
00039      */
00040     class ANALOG_API agc_cc : virtual public gr_sync_block
00041     {
00042     public:
00043       // gr::analog::agc_cc::sptr
00044       typedef boost::shared_ptr<agc_cc> sptr;
00045             
00046       static sptr make(float rate = 1e-4, float reference = 1.0,
00047                        float gain = 1.0, float max_gain = 0.0);
00048 
00049       virtual float rate() const = 0;
00050       virtual float reference() const = 0;
00051       virtual float gain() const = 0;
00052       virtual float max_gain() const = 0;
00053       
00054       virtual void set_rate(float rate) = 0;
00055       virtual void set_reference(float reference) = 0;
00056       virtual void set_gain(float gain) = 0;
00057       virtual void set_max_gain(float max_gain) = 0;
00058     };
00059 
00060   } /* namespace analog */
00061 } /* namespace gr */
00062 
00063 #endif /* INCLUDED_ANALOG_AGC_CC_H */