GNU Radio 3.7.2 C++ API
agc2_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,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_AGC2_CC_H
24 #define INCLUDED_ANALOG_AGC2_CC_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/analog/agc2.h>
28 #include <gnuradio/sync_block.h>
29 
30 namespace gr {
31  namespace analog {
32 
33  /*!
34  * \brief high performance Automatic Gain Control class with
35  * attack and decay rates.
36  * \ingroup level_controllers_blk
37  *
38  * \details
39  * For Power the absolute value of the complex number is used.
40  */
41  class ANALOG_API agc2_cc : virtual public sync_block
42  {
43  public:
44  // gr::analog::agc2_cc::sptr
46 
47  /*!
48  * Build a complex value AGC loop block with attack and decay rates.
49  *
50  * \param attack_rate the update rate of the loop when in attack mode.
51  * \param decay_rate the update rate of the loop when in decay mode.
52  * \param reference reference value to adjust signal power to.
53  * \param gain initial gain value.
54  */
55  static sptr make(float attack_rate = 1e-1, float decay_rate = 1e-2,
56  float reference = 1.0, float gain = 1.0);
57 
58  virtual float attack_rate() const = 0;
59  virtual float decay_rate() const = 0;
60  virtual float reference() const = 0;
61  virtual float gain() const = 0;
62  virtual float max_gain() const = 0;
63 
64  virtual void set_attack_rate(float rate) = 0;
65  virtual void set_decay_rate(float rate) = 0;
66  virtual void set_reference(float reference) = 0;
67  virtual void set_gain(float gain) = 0;
68  virtual void set_max_gain(float max_gain) = 0;
69  };
70 
71  } /* namespace analog */
72 } /* namespace gr */
73 
74 #endif /* INCLUDED_ANALOG_AGC2_CC_H */
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
high performance Automatic Gain Control class with attack and decay rates.
Definition: agc2_cc.h:41
boost::shared_ptr< agc2_cc > sptr
Definition: agc2_cc.h:45
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30