GNU Radio v3.6.2-149-ga6d285d9 C++ API
pll_refout_cc.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2011,2012 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_REFOUT_CC_H
00024 #define INCLUDED_ANALOG_PLL_REFOUT_CC_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 a carrier
00034      * \ingroup sync_blk
00035      *
00036      * Input stream 0: complex
00037      * Output stream 0: complex
00038      *
00039      * This PLL locks onto a [possibly noisy] reference carrier on the
00040      * input and outputs a clean version which is phase and frequency
00041      * aligned to it.
00042      *
00043      * All settings max_freq and min_freq are in terms of radians per
00044      * sample, NOT HERTZ. The loop bandwidth determins the lock range
00045      * and should be set around pi/200 -- 2pi/100.  \sa
00046      * pll_freqdet_cf, pll_carriertracking_cc
00047      */
00048     class ANALOG_API pll_refout_cc : virtual public gr_sync_block
00049     {
00050     public:
00051       // gr::analog::pll_refout_cc::sptr
00052       typedef boost::shared_ptr<pll_refout_cc> sptr;
00053       
00054       /* \brief Make PLL block that outputs the tracked carrier signal.
00055        *
00056        * \param loop_bw: control loop's bandwidth parameter.
00057        * \param max_freq: maximum (normalized) frequency PLL will lock to.
00058        * \param min_freq: minimum (normalized) frequency PLL will lock to.
00059        */
00060       static sptr make(float loop_bw, float max_freq, float min_freq);
00061     };
00062 
00063   } /* namespace analog */
00064 } /* namespace gr */
00065 
00066 #endif /* INCLUDED_ANALOG_PLL_REFOUT_CC_H */