GNU Radio 3.7.2 C++ API
agc_ff.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,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_AGC_FF_H
24 #define INCLUDED_ANALOG_AGC_FF_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/analog/agc.h>
28 #include <gnuradio/sync_block.h>
29 
30 namespace gr {
31  namespace analog {
32 
33  /*!
34  * \brief high performance Automatic Gain Control class
35  * \ingroup level_controllers_blk
36  *
37  * \details
38  * Power is approximated by absolute value
39  */
40  class ANALOG_API agc_ff : virtual public sync_block
41  {
42  public:
43  // gr::analog::agc_ff::sptr
45 
46  /*!
47  * Build a floating point AGC loop block.
48  *
49  * \param rate the update rate of the loop.
50  * \param reference reference value to adjust signal power to.
51  * \param gain initial gain value.
52  */
53  static sptr make(float rate = 1e-4, float reference = 1.0,
54  float gain = 1.0);
55 
56  virtual float rate() const = 0;
57  virtual float reference() const = 0;
58  virtual float gain() const = 0;
59  virtual float max_gain() const = 0;
60 
61  virtual void set_rate(float rate) = 0;
62  virtual void set_reference(float reference) = 0;
63  virtual void set_gain(float gain) = 0;
64  virtual void set_max_gain(float max_gain) = 0;
65  };
66 
67  } /* namespace analog */
68 } /* namespace gr */
69 
70 #endif /* INCLUDED_ANALOG_AGC_FF_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
Definition: agc_ff.h:40
boost::shared_ptr< agc_ff > sptr
Definition: agc_ff.h:44
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30