GNU Radio 3.5.3.1 C++ API
gr_pll_refout_cc.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_GR_PLL_REFOUT_CC_H
24 #define INCLUDED_GR_PLL_REFOUT_CC_H
25 
26 #include <gr_core_api.h>
27 #include <gr_sync_block.h>
28 #include <gri_control_loop.h>
29 
30 class gr_pll_refout_cc;
32 
34  float max_freq, float min_freq);
35 /*!
36  * \brief Implements a PLL which locks to the input frequency and outputs a carrier
37  * \ingroup sync_blk
38  *
39  * input: stream of complex; output: stream of complex
40  *
41  * This PLL locks onto a [possibly noisy] reference carrier on
42  * the input and outputs a clean version which is phase and frequency
43  * aligned to it.
44  *
45  * All settings max_freq and min_freq are in terms of radians per sample,
46  * NOT HERTZ. The loop bandwidth determins the lock range and should be set
47  * around pi/200 -- 2pi/100.
48  * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc
49  */
51 {
53  float max_freq, float min_freq);
54 
55  gr_pll_refout_cc (float loop_bw, float max_freq, float min_freq);
56 
57  int work (int noutput_items,
58  gr_vector_const_void_star &input_items,
59  gr_vector_void_star &output_items);
60 private:
61  float mod_2pi (float in);
62  float phase_detector(gr_complex sample, float ref_phase);
63 };
64 
65 #endif