GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
agc_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_AGC_CC_H
12 #define INCLUDED_ANALOG_AGC_CC_H
13 
14 #include <gnuradio/analog/agc.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
23  * \ingroup level_controllers_blk
24  *
25  * \details
26  * For Power the absolute value of the complex number is used.
27  */
28 class ANALOG_API agc_cc : virtual public sync_block
29 {
30 public:
31  // gr::analog::agc_cc::sptr
32  typedef std::shared_ptr<agc_cc> sptr;
33 
34  /*!
35  * Build a complex value AGC loop block.
36  *
37  * \param rate the update rate of the loop.
38  * \param reference reference value to adjust signal power to.
39  * \param gain initial gain value.
40  * \param max_gain maximum gain value (0 for unlimited).
41  */
42  static sptr make(float rate = 1e-4,
43  float reference = 1.0,
44  float gain = 1.0,
45  float max_gain = 0.0);
46 
47  virtual float rate() const = 0;
48  virtual float reference() const = 0;
49  virtual float gain() const = 0;
50  virtual float max_gain() const = 0;
51 
52  virtual void set_rate(float rate) = 0;
53  virtual void set_reference(float reference) = 0;
54  virtual void set_gain(float gain) = 0;
55  virtual void set_max_gain(float max_gain) = 0;
56 };
57 
58 } /* namespace analog */
59 } /* namespace gr */
60 
61 #endif /* INCLUDED_ANALOG_AGC_CC_H */
high performance Automatic Gain Control class
Definition: agc_cc.h:29
virtual void set_rate(float rate)=0
virtual float reference() const =0
virtual void set_max_gain(float max_gain)=0
virtual void set_reference(float reference)=0
static sptr make(float rate=1e-4, float reference=1.0, float gain=1.0, float max_gain=0.0)
virtual float gain() const =0
virtual void set_gain(float gain)=0
virtual float max_gain() const =0
std::shared_ptr< agc_cc > sptr
Definition: agc_cc.h:32
virtual float 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