GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
pll_refout_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2011,2012 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_ANALOG_PLL_REFOUT_CC_H
24#define INCLUDED_ANALOG_PLL_REFOUT_CC_H
25
26#include <gnuradio/analog/api.h>
28#include <gnuradio/sync_block.h>
29
30namespace gr {
31namespace analog {
32
33/*!
34 * \brief Implements a PLL which locks to the input frequency and outputs a carrier
35 * \ingroup synchronizers_blk
36 *
37 * \details
38 * Input stream 0: complex
39 * Output stream 0: complex
40 *
41 * This PLL locks onto a [possibly noisy] reference carrier on the
42 * 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
46 * sample, NOT HERTZ. The loop bandwidth determines the lock range
47 * and should be set around pi/200 -- 2pi/100. \sa
48 * pll_freqdet_cf, pll_carriertracking_cc
49 */
50class ANALOG_API pll_refout_cc : virtual public sync_block,
51 virtual public blocks::control_loop
52{
53public:
54 // gr::analog::pll_refout_cc::sptr
55 typedef boost::shared_ptr<pll_refout_cc> sptr;
56
57 /* \brief Make PLL block that outputs the tracked carrier signal.
58 *
59 * \param loop_bw: control loop's bandwidth parameter.
60 * \param max_freq: maximum (normalized) frequency PLL will lock to.
61 * \param min_freq: minimum (normalized) frequency PLL will lock to.
62 */
63 static sptr make(float loop_bw, float max_freq, float min_freq);
64};
65
66} /* namespace analog */
67} /* namespace gr */
68
69#endif /* INCLUDED_ANALOG_PLL_REFOUT_CC_H */
Implements a PLL which locks to the input frequency and outputs a carrier.
Definition: pll_refout_cc.h:52
boost::shared_ptr< pll_refout_cc > sptr
Definition: pll_refout_cc.h:55
static sptr make(float loop_bw, float max_freq, float min_freq)
A second-order control loop implementation class.
Definition: control_loop.h:62
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45