GNU Radio 3.6.5.1 C++ API
pll_freqdet_cf.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2011 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_PLL_FREQDET_CF_H
24 #define INCLUDED_ANALOG_PLL_FREQDET_CF_H
25 
26 #include <analog/api.h>
27 #include <gr_sync_block.h>
28 
29 namespace gr {
30  namespace analog {
31 
32  /*!
33  * \brief Implements a PLL which locks to the input frequency and outputs
34  * an estimate of that frequency. Useful for FM Demod.
35  * \ingroup synchronizers_blk
36  *
37  * \details
38  * Input stream 0: complex
39  * Output stream 0: float
40  *
41  * This PLL locks onto a [possibly noisy] reference carrier on
42  * the input and outputs an estimate of that frequency in radians per sample.
43  * All settings max_freq and min_freq are in terms of radians per sample,
44  * NOT HERTZ. The loop bandwidth determins the lock range and should be set
45  * around pi/200 -- 2pi/100.
46  * \sa pll_refout_cc, pll_carriertracking_cc
47  */
48  class ANALOG_API pll_freqdet_cf : virtual public gr_sync_block
49  {
50  public:
51  // gr::analog::pll_freqdet_cf::sptr
53 
54  /* \brief Make PLL block that outputs the tracked signal's frequency.
55  *
56  * \param loop_bw: control loop's bandwidth parameter.
57  * \param max_freq: maximum (normalized) frequency PLL will lock to.
58  * \param min_freq: minimum (normalized) frequency PLL will lock to.
59  */
60  static sptr make(float loop_bw, float max_freq, float min_freq);
61 
62  virtual void set_loop_bandwidth(float bw) = 0;
63  virtual void set_damping_factor(float df) = 0;
64  virtual void set_alpha(float alpha) = 0;
65  virtual void set_beta(float beta) = 0;
66  virtual void set_frequency(float freq) = 0;
67  virtual void set_phase(float phase) = 0;
68  virtual void set_min_freq(float freq) = 0;
69  virtual void set_max_freq(float freq) = 0;
70 
71  virtual float get_loop_bandwidth() const = 0;
72  virtual float get_damping_factor() const = 0;
73  virtual float get_alpha() const = 0;
74  virtual float get_beta() const = 0;
75  virtual float get_frequency() const = 0;
76  virtual float get_phase() const = 0;
77  virtual float get_min_freq() const = 0;
78  virtual float get_max_freq() const = 0;
79  };
80 
81  } /* namespace analog */
82 } /* namespace gr */
83 
84 #endif /* INCLUDED_ANALOG_PLL_FREQDET_CF_H */