GNU Radio's LFAST Package
agc_fast_ff.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2017 ghostop14.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 
22 #ifndef INCLUDED_LFAST_AGC_FAST_FF_H
23 #define INCLUDED_LFAST_AGC_FAST_FF_H
24 
25 #include <lfast/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace lfast {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup lfast
34  *
35  */
36  class LFAST_API agc_fast_ff : virtual public gr::sync_block
37  {
38  public:
39  typedef boost::shared_ptr<agc_fast_ff> sptr;
40 
41  /*!
42  * \brief Return a shared_ptr to a new instance of lfast::agc_fast.
43  *
44  * To avoid accidental use of raw pointers, lfast::agc_fast's
45  * constructor is in a private implementation
46  * class. lfast::agc_fast::make is the public interface for
47  * creating new instances.
48  */
49  static sptr make(float rate = 1e-4, float reference = 1.0, float gain = 1.0);
50  virtual float rate() const = 0;
51  virtual float reference() const = 0;
52  virtual float gain() const = 0;
53  virtual float max_gain() const = 0;
54 
55  virtual void set_rate(float rate) = 0;
56  virtual void set_reference(float reference) = 0;
57  virtual void set_gain(float gain) = 0;
58  virtual void set_max_gain(float max_gain) = 0;
59  };
60 
61  } // namespace lfast
62 } // namespace gr
63 
64 #endif /* INCLUDED_LFAST_AGC_FAST_FF_H */
65 
#define LFAST_API
Definition: api.h:30
<+description of block+>
Definition: agc_fast_ff.h:36
boost::shared_ptr< agc_fast_ff > sptr
Definition: agc_fast_ff.h:39