GNU Radio 3.6.4.1 C++ API
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 <
analog/api.h
>
27
#include <
gr_sync_block.h
>
28
29
namespace
gr {
30
namespace
analog {
31
32
/*!
33
* \brief Implements a PLL which locks to the input frequency and outputs the
34
* input signal mixed with that carrier.
35
* \ingroup sync_blk
36
*
37
* Input stream 0: complex
38
* Output stream 0: complex
39
*
40
* This PLL locks onto a [possibly noisy] reference carrier on the
41
* input and outputs that signal, downconverted to DC
42
*
43
* All settings max_freq and min_freq are in terms of radians per
44
* sample, NOT HERTZ. The loop bandwidth determins the lock range
45
* and should be set around pi/200 -- 2pi/100. \sa
46
* pll_freqdet_cf, pll_carriertracking_cc
47
*/
48
class
ANALOG_API
pll_carriertracking_cc
:
virtual
public
gr_sync_block
49
{
50
public
:
51
// gr::analog::pll_carriertracking_cc::sptr
52
typedef
boost::shared_ptr<pll_carriertracking_cc>
sptr
;
53
54
/* \brief Make a carrier tracking PLL block.
55
*
56
* \param loop_bw: control loop's bandwidth parameter.
57
* \param max_freq: maximum (normalized) frequency PLL will lock to.
58
* \param min_freq: minimum (normalized) frequency PLL will lock to.
59
*/
60
static
sptr
make(
float
loop_bw,
float
max_freq,
float
min_freq);
61
62
virtual
bool
lock_detector(
void
) = 0;
63
virtual
bool
squelch_enable(
bool
) = 0;
64
virtual
float
set_lock_threshold(
float
) = 0;
65
66
virtual
void
set_loop_bandwidth(
float
bw) = 0;
67
virtual
void
set_damping_factor(
float
df) = 0;
68
virtual
void
set_alpha(
float
alpha) = 0;
69
virtual
void
set_beta(
float
beta) = 0;
70
virtual
void
set_frequency(
float
freq) = 0;
71
virtual
void
set_phase(
float
phase) = 0;
72
virtual
void
set_min_freq(
float
freq) = 0;
73
virtual
void
set_max_freq(
float
freq) = 0;
74
75
virtual
float
get_loop_bandwidth()
const
= 0;
76
virtual
float
get_damping_factor()
const
= 0;
77
virtual
float
get_alpha()
const
= 0;
78
virtual
float
get_beta()
const
= 0;
79
virtual
float
get_frequency()
const
= 0;
80
virtual
float
get_phase()
const
= 0;
81
virtual
float
get_min_freq()
const
= 0;
82
virtual
float
get_max_freq()
const
= 0;
83
};
84
85
}
/* namespace analog */
86
}
/* namespace gr */
87
88
#endif
/* INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H */
gr-analog
include
analog
pll_carriertracking_cc.h
Generated on Thu Mar 21 2013 15:59:34 for GNU Radio 3.6.4.1 C++ API by
1.8.1.2