GNU Radio's LFAST Package
agc_fast.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_H
23 #define INCLUDED_LFAST_AGC_FAST_H
24 
25 #include <lfast/api.h>
26 #include <gnuradio/sync_block.h>
27 #include "agc.h"
28 
29 namespace gr {
30  namespace lfast {
31 
32  /*!
33  * \brief <+description of block+>
34  * \ingroup lfast
35  *
36  */
37  class LFAST_API agc_fast : virtual public gr::sync_block
38  {
39  public:
40  typedef boost::shared_ptr<agc_fast> sptr;
41 
42  /*!
43  * \brief Return a shared_ptr to a new instance of lfast::agc_fast.
44  *
45  * To avoid accidental use of raw pointers, lfast::agc_fast's
46  * constructor is in a private implementation
47  * class. lfast::agc_fast::make is the public interface for
48  * creating new instances.
49  */
50  static sptr make(float rate = 1e-4, float reference = 1.0, float gain = 1.0);
51  virtual float rate() const = 0;
52  virtual float reference() const = 0;
53  virtual float gain() const = 0;
54  virtual float max_gain() const = 0;
55 
56  virtual void set_rate(float rate) = 0;
57  virtual void set_reference(float reference) = 0;
58  virtual void set_gain(float gain) = 0;
59  virtual void set_max_gain(float max_gain) = 0;
60  };
61 
62  } // namespace lfast
63 } // namespace gr
64 
65 #endif /* INCLUDED_LFAST_AGC_FAST_H */
66 
boost::shared_ptr< agc_fast > sptr
Definition: agc_fast.h:40
#define LFAST_API
Definition: api.h:30
<+description of block+>
Definition: agc_fast.h:37