GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
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/agc.h>
27#include <gnuradio/analog/api.h>
28#include <gnuradio/sync_block.h>
29
30namespace gr {
31namespace 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 */
40class ANALOG_API agc_ff : virtual public sync_block
41{
42public:
43 // gr::analog::agc_ff::sptr
44 typedef boost::shared_ptr<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, float gain = 1.0);
54
55 virtual float rate() const = 0;
56 virtual float reference() const = 0;
57 virtual float gain() const = 0;
58 virtual float max_gain() const = 0;
59
60 virtual void set_rate(float rate) = 0;
61 virtual void set_reference(float reference) = 0;
62 virtual void set_gain(float gain) = 0;
63 virtual void set_max_gain(float max_gain) = 0;
64};
65
66} /* namespace analog */
67} /* namespace gr */
68
69#endif /* INCLUDED_ANALOG_AGC_FF_H */
high performance Automatic Gain Control class
Definition: agc_ff.h:41
virtual float max_gain() const =0
virtual float rate() const =0
virtual void set_max_gain(float max_gain)=0
virtual float gain() const =0
virtual float reference() const =0
virtual void set_rate(float rate)=0
virtual void set_gain(float gain)=0
boost::shared_ptr< agc_ff > sptr
Definition: agc_ff.h:44
virtual void set_reference(float reference)=0
static sptr make(float rate=1e-4, float reference=1.0, float gain=1.0)
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45