GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
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  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_ANALOG_AGC2_CC_H
12 #define INCLUDED_ANALOG_AGC2_CC_H
13 
14 #include <gnuradio/analog/agc2.h>
15 #include <gnuradio/analog/api.h>
16 #include <gnuradio/sync_block.h>
17 
18 namespace gr {
19 namespace analog {
20 
21 /*!
22  * \brief high performance Automatic Gain Control class with
23  * attack and decay rates.
24  * \ingroup level_controllers_blk
25  *
26  * \details
27  * For Power the absolute value of the complex number is used.
28  */
29 class ANALOG_API agc2_cc : virtual public sync_block
30 {
31 public:
32  // gr::analog::agc2_cc::sptr
33  typedef std::shared_ptr<agc2_cc> sptr;
34 
35  /*!
36  * Build a complex value AGC loop block with attack and decay rates.
37  *
38  * \param attack_rate the update rate of the loop when in attack mode.
39  * \param decay_rate the update rate of the loop when in decay mode.
40  * \param reference reference value to adjust signal power to.
41  * \param gain initial gain value.
42  * \param max_gain maximum gain value (0 for unlimited).
43  */
44  static sptr make(float attack_rate = 1e-1,
45  float decay_rate = 1e-2,
46  float reference = 1.0,
47  float gain = 1.0,
48  float max_gain = 0.0);
49 
50  virtual float attack_rate() const = 0;
51  virtual float decay_rate() const = 0;
52  virtual float reference() const = 0;
53  virtual float gain() const = 0;
54  virtual float max_gain() const = 0;
55 
56  virtual void set_attack_rate(float rate) = 0;
57  virtual void set_decay_rate(float rate) = 0;
58  virtual void set_reference(float reference) = 0;
59  virtual void set_gain(float gain) = 0;
60  virtual void set_max_gain(float max_gain) = 0;
61 };
62 
63 } /* namespace analog */
64 } /* namespace gr */
65 
66 #endif /* INCLUDED_ANALOG_AGC2_CC_H */
high performance Automatic Gain Control class with attack and decay rates.
Definition: agc2_cc.h:30
virtual float reference() const =0
virtual void set_max_gain(float max_gain)=0
virtual float gain() const =0
virtual void set_decay_rate(float rate)=0
std::shared_ptr< agc2_cc > sptr
Definition: agc2_cc.h:33
virtual void set_reference(float reference)=0
static sptr make(float attack_rate=1e-1, float decay_rate=1e-2, float reference=1.0, float gain=1.0, float max_gain=0.0)
virtual float max_gain() const =0
virtual float decay_rate() const =0
virtual void set_gain(float gain)=0
virtual void set_attack_rate(float rate)=0
virtual float attack_rate() const =0
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:18
GNU Radio logging wrapper.
Definition: basic_block.h:29