pll_carriertracking_cc.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2004,2006,2011,2012 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */
 
#ifndef INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H
#define INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H
 
#include <gnuradio/analog/api.h>
#include <gnuradio/blocks/control_loop.h>
#include <gnuradio/sync_block.h>
 
namespace gr {
namespace analog {
 
/*!
 * \brief Implements a PLL which locks to the input frequency and outputs the
 * input signal mixed with that carrier.
 * \ingroup synchronizers_blk
 *
 * \details
 * Input stream 0: complex
 * Output stream 0: complex
 *
 * This PLL locks onto a [possibly noisy] reference carrier on the
 * input and outputs that signal, downconverted to DC
 *
 * All settings max_freq and min_freq are in terms of radians per
 * sample, NOT HERTZ. The loop bandwidth determines the lock range
 * and should be set around pi/200 -- 2pi/100.  \sa
 * pll_freqdet_cf, pll_carriertracking_cc
 */
class ANALOG_API pll_carriertracking_cc : virtual public sync_block,
                                          virtual public blocks::control_loop
{
public:
    // gr::analog::pll_carriertracking_cc::sptr
    typedef std::shared_ptr<pll_carriertracking_cc> sptr;
 
    /* \brief Make a carrier tracking PLL block.
     *
     * \param loop_bw: control loop's bandwidth parameter.
     * \param max_freq: maximum (normalized) frequency PLL will lock to.
     * \param min_freq: minimum (normalized) frequency PLL will lock to.
     */
    static sptr make(float loop_bw, float max_freq, float min_freq);
 
    virtual bool lock_detector(void) = 0;
    virtual bool squelch_enable(bool) = 0;
    virtual float set_lock_threshold(float) = 0;
 
    void set_loop_bandwidth(float bw) override = 0;
    virtual void set_damping_factor(float df) = 0;
    virtual void set_alpha(float alpha) = 0;
    virtual void set_beta(float beta) = 0;
    virtual void set_frequency(float freq) = 0;
    virtual void set_phase(float phase) = 0;
    virtual void set_min_freq(float freq) = 0;
    virtual void set_max_freq(float freq) = 0;
 
    virtual float get_loop_bandwidth() const = 0;
    virtual float get_damping_factor() const = 0;
    virtual float get_alpha() const = 0;
    virtual float get_beta() const = 0;
    virtual float get_frequency() const = 0;
    virtual float get_phase() const = 0;
    virtual float get_min_freq() const = 0;
    virtual float get_max_freq() const = 0;
};
 
} /* namespace analog */
} /* namespace gr */
 
#endif /* INCLUDED_ANALOG_PLL_CARRIERTRACKING_CC_H */