GNU Radio v3.6.2-149-ga6d285d9 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2004,2011 Free Software Foundation, Inc. 00004 * 00005 * This file is part of GNU Radio 00006 * 00007 * GNU Radio is free software; you can redistribute it and/or modify 00008 * it under the terms of the GNU General Public License as published by 00009 * the Free Software Foundation; either version 3, or (at your option) 00010 * any later version. 00011 * 00012 * GNU Radio is distributed in the hope that it will be useful, 00013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 * GNU General Public License for more details. 00016 * 00017 * You should have received a copy of the GNU General Public License 00018 * along with GNU Radio; see the file COPYING. If not, write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, 00020 * Boston, MA 02110-1301, USA. 00021 */ 00022 00023 #ifndef INCLUDED_ANALOG_PLL_FREQDET_CF_H 00024 #define INCLUDED_ANALOG_PLL_FREQDET_CF_H 00025 00026 #include <analog/api.h> 00027 #include <gr_sync_block.h> 00028 00029 namespace gr { 00030 namespace analog { 00031 00032 /*! 00033 * \brief Implements a PLL which locks to the input frequency and outputs 00034 * an estimate of that frequency. Useful for FM Demod. 00035 * \ingroup sync_blk 00036 * 00037 * Input stream 0: complex 00038 * Output stream 0: float 00039 * 00040 * This PLL locks onto a [possibly noisy] reference carrier on 00041 * the input and outputs an estimate of that frequency in radians per sample. 00042 * All settings max_freq and min_freq are in terms of radians per sample, 00043 * NOT HERTZ. The loop bandwidth determins the lock range and should be set 00044 * around pi/200 -- 2pi/100. 00045 * \sa pll_refout_cc, pll_carriertracking_cc 00046 */ 00047 class ANALOG_API pll_freqdet_cf : virtual public gr_sync_block 00048 { 00049 public: 00050 // gr::analog::pll_freqdet_cf::sptr 00051 typedef boost::shared_ptr<pll_freqdet_cf> sptr; 00052 00053 /* \brief Make PLL block that outputs the tracked signal's frequency. 00054 * 00055 * \param loop_bw: control loop's bandwidth parameter. 00056 * \param max_freq: maximum (normalized) frequency PLL will lock to. 00057 * \param min_freq: minimum (normalized) frequency PLL will lock to. 00058 */ 00059 static sptr make(float loop_bw, float max_freq, float min_freq); 00060 00061 virtual void set_loop_bandwidth(float bw) = 0; 00062 virtual void set_damping_factor(float df) = 0; 00063 virtual void set_alpha(float alpha) = 0; 00064 virtual void set_beta(float beta) = 0; 00065 virtual void set_frequency(float freq) = 0; 00066 virtual void set_phase(float phase) = 0; 00067 virtual void set_min_freq(float freq) = 0; 00068 virtual void set_max_freq(float freq) = 0; 00069 00070 virtual float get_loop_bandwidth() const = 0; 00071 virtual float get_damping_factor() const = 0; 00072 virtual float get_alpha() const = 0; 00073 virtual float get_beta() const = 0; 00074 virtual float get_frequency() const = 0; 00075 virtual float get_phase() const = 0; 00076 virtual float get_min_freq() const = 0; 00077 virtual float get_max_freq() const = 0; 00078 }; 00079 00080 } /* namespace analog */ 00081 } /* namespace gr */ 00082 00083 #endif /* INCLUDED_ANALOG_PLL_FREQDET_CF_H */