GNU Radio 3.7.1 C++ API
pll_freqdet_cf.h
Go to the documentation of this file.
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 <gnuradio/analog/api.h>
00027 #include <gnuradio/blocks/control_loop.h>
00028 #include <gnuradio/sync_block.h>
00029 
00030 namespace gr {
00031   namespace analog {
00032     
00033     /*!
00034      * \brief Implements a PLL which locks to the input frequency and outputs
00035      * an estimate of that frequency.  Useful for FM Demod.
00036      * \ingroup synchronizers_blk
00037      *
00038      * \details
00039      * Input stream 0: complex
00040      * Output stream 0: float
00041      *
00042      * This PLL locks onto a [possibly noisy] reference carrier on
00043      * the input and outputs an estimate of that frequency in radians per sample.
00044      * All settings max_freq and min_freq are in terms of radians per sample,
00045      * NOT HERTZ.  The loop bandwidth determins the lock range and should be set
00046      * around pi/200 -- 2pi/100.
00047      * \sa pll_refout_cc, pll_carriertracking_cc
00048      */
00049     class ANALOG_API pll_freqdet_cf
00050       : virtual public sync_block,
00051         virtual public blocks::control_loop
00052     {
00053     public:
00054       // gr::analog::pll_freqdet_cf::sptr
00055       typedef boost::shared_ptr<pll_freqdet_cf> sptr;
00056       
00057       /* \brief Make PLL block that outputs the tracked signal's frequency.
00058        *
00059        * \param loop_bw: control loop's bandwidth parameter.
00060        * \param max_freq: maximum (normalized) frequency PLL will lock to.
00061        * \param min_freq: minimum (normalized) frequency PLL will lock to.
00062        */
00063       static sptr make(float loop_bw, float max_freq, float min_freq);
00064 
00065       virtual void set_loop_bandwidth(float bw) = 0;
00066       virtual void set_damping_factor(float df) = 0;
00067       virtual void set_alpha(float alpha) = 0;
00068       virtual void set_beta(float beta) = 0;
00069       virtual void set_frequency(float freq) = 0;
00070       virtual void set_phase(float phase) = 0;
00071       virtual void set_min_freq(float freq) = 0;
00072       virtual void set_max_freq(float freq) = 0;
00073 
00074       virtual float get_loop_bandwidth() const = 0;
00075       virtual float get_damping_factor() const = 0;
00076       virtual float get_alpha() const = 0;
00077       virtual float get_beta() const = 0;
00078       virtual float get_frequency() const = 0;
00079       virtual float get_phase() const = 0;
00080       virtual float get_min_freq() const = 0;
00081       virtual float get_max_freq() const = 0;
00082     };
00083 
00084   } /* namespace analog */
00085 } /* namespace gr */
00086 
00087 #endif /* INCLUDED_ANALOG_PLL_FREQDET_CF_H */