GNU Radio v3.6.2-149-ga6d285d9 C++ API
|
00001 /* -*- c++ -*- */ 00002 /* 00003 * Copyright 2004,2006,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_CARRIERTRACKING_CC_H 00024 #define INCLUDED_ANALOG_PLL_CARRIERTRACKING_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 the 00034 * input signal mixed with that carrier. 00035 * \ingroup sync_blk 00036 * 00037 * Input stream 0: complex 00038 * Output stream 0: complex 00039 * 00040 * This PLL locks onto a [possibly noisy] reference carrier on the 00041 * input and outputs that signal, downconverted to DC 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_carriertracking_cc : virtual public gr_sync_block 00049 { 00050 public: 00051 // gr::analog::pll_carriertracking_cc::sptr 00052 typedef boost::shared_ptr<pll_carriertracking_cc> sptr; 00053 00054 /* \brief Make a carrier tracking PLL block. 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 virtual bool lock_detector(void) = 0; 00063 virtual bool squelch_enable(bool) = 0; 00064 virtual float set_lock_threshold(float) = 0; 00065 00066 virtual void set_loop_bandwidth(float bw) = 0; 00067 virtual void set_damping_factor(float df) = 0; 00068 virtual void set_alpha(float alpha) = 0; 00069 virtual void set_beta(float beta) = 0; 00070 virtual void set_frequency(float freq) = 0; 00071 virtual void set_phase(float phase) = 0; 00072 virtual void set_min_freq(float freq) = 0; 00073 virtual void set_max_freq(float freq) = 0; 00074 00075 virtual float get_loop_bandwidth() const = 0; 00076 virtual float get_damping_factor() const = 0; 00077 virtual float get_alpha() const = 0; 00078 virtual float get_beta() const = 0; 00079 virtual float get_frequency() const = 0; 00080 virtual float get_phase() const = 0; 00081 virtual float get_min_freq() const = 0; 00082 virtual float get_max_freq() const = 0; 00083 }; 00084 00085 } /* namespace analog */ 00086 } /* namespace gr */ 00087 00088 #endif /* INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H */