GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
pll_carriertracking_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2006,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_CARRIERTRACKING_CC_H
24#define INCLUDED_ANALOG_PLL_CARRIERTRACKING_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 the
35 * input signal mixed with that carrier.
36 * \ingroup synchronizers_blk
37 *
38 * \details
39 * Input stream 0: complex
40 * Output stream 0: complex
41 *
42 * This PLL locks onto a [possibly noisy] reference carrier on the
43 * input and outputs that signal, downconverted to DC
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 */
51 virtual public blocks::control_loop
52{
53public:
54 // gr::analog::pll_carriertracking_cc::sptr
55 typedef boost::shared_ptr<pll_carriertracking_cc> sptr;
56
57 /* \brief Make a carrier tracking PLL block.
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 virtual bool lock_detector(void) = 0;
66 virtual bool squelch_enable(bool) = 0;
67 virtual float set_lock_threshold(float) = 0;
68
69 virtual void set_loop_bandwidth(float bw) = 0;
70 virtual void set_damping_factor(float df) = 0;
71 virtual void set_alpha(float alpha) = 0;
72 virtual void set_beta(float beta) = 0;
73 virtual void set_frequency(float freq) = 0;
74 virtual void set_phase(float phase) = 0;
75 virtual void set_min_freq(float freq) = 0;
76 virtual void set_max_freq(float freq) = 0;
77
78 virtual float get_loop_bandwidth() const = 0;
79 virtual float get_damping_factor() const = 0;
80 virtual float get_alpha() const = 0;
81 virtual float get_beta() const = 0;
82 virtual float get_frequency() const = 0;
83 virtual float get_phase() const = 0;
84 virtual float get_min_freq() const = 0;
85 virtual float get_max_freq() const = 0;
86};
87
88} /* namespace analog */
89} /* namespace gr */
90
91#endif /* INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H */
Implements a PLL which locks to the input frequency and outputs the input signal mixed with that carr...
Definition: pll_carriertracking_cc.h:52
static sptr make(float loop_bw, float max_freq, float min_freq)
virtual void set_phase(float phase)=0
virtual float get_max_freq() const =0
virtual void set_max_freq(float freq)=0
virtual void set_alpha(float alpha)=0
boost::shared_ptr< pll_carriertracking_cc > sptr
Definition: pll_carriertracking_cc.h:55
virtual float set_lock_threshold(float)=0
virtual void set_damping_factor(float df)=0
virtual float get_min_freq() const =0
virtual bool lock_detector(void)=0
virtual float get_frequency() const =0
virtual void set_loop_bandwidth(float bw)=0
Set the loop bandwidth.
virtual void set_min_freq(float freq)=0
virtual float get_damping_factor() const =0
virtual void set_frequency(float freq)=0
virtual float get_beta() const =0
virtual float get_phase() const =0
virtual float get_loop_bandwidth() const =0
virtual void set_beta(float beta)=0
virtual float get_alpha() const =0
virtual bool squelch_enable(bool)=0
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