GNU Radio C++ API Reference: agc_ff.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_ANALOG_AGC_FF_H
12#define INCLUDED_ANALOG_AGC_FF_H
13
14#include <gnuradio/analog/agc.h>
15#include <gnuradio/analog/api.h>
16#include <gnuradio/sync_block.h>
17
18namespace gr {
19namespace analog {
20
21/*!
22 * \brief high performance Automatic Gain Control class
23 * \ingroup level_controllers_blk
24 *
25 * \details
26 * Power is approximated by absolute value
27 */
28 class ANALOG_API agc_ff : virtual public sync_block
29{
30public:
31 // gr::analog::agc_ff::sptr
32 typedef std::shared_ptr<agc_ff> sptr;
33
34 /*!
35 * Build a floating point 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_FF_H */
agc.h
gr::analog::agc_ff
high performance Automatic Gain Control class
Definition agc_ff.h:29
gr::analog::agc_ff::max_gain
virtual float max_gain() const =0
gr::analog::agc_ff::make
static sptr make(float rate=1e-4, float reference=1.0, float gain=1.0, float max_gain=0.0)
gr::analog::agc_ff::rate
virtual float rate() const =0
gr::analog::agc_ff::set_max_gain
virtual void set_max_gain(float max_gain)=0
gr::analog::agc_ff::gain
virtual float gain() const =0
gr::analog::agc_ff::reference
virtual float reference() const =0
gr::analog::agc_ff::set_rate
virtual void set_rate(float rate)=0
gr::analog::agc_ff::set_gain
virtual void set_gain(float gain)=0
gr::analog::agc_ff::sptr
std::shared_ptr< agc_ff > sptr
Definition agc_ff.h:32
gr::analog::agc_ff::set_reference
virtual void set_reference(float reference)=0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
ANALOG_API
#define ANALOG_API
Definition gr-analog/include/gnuradio/analog/api.h:18
gr::analog
Definition agc.h:19
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h