GNU Radio 3.7.1 C++ API
clock_recovery_mm_ff.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2011,2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H
00024 #define INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/block.h>
00028 
00029 namespace gr {
00030   namespace digital {
00031     
00032     /*!
00033      * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output.
00034      * \ingroup synchronizers_blk
00035      *
00036      * \details
00037      * This implements the Mueller and Müller (M&M) discrete-time
00038      * error-tracking synchronizer.
00039      *
00040      * See "Digital Communication Receivers: Synchronization, Channel
00041      * Estimation and Signal Processing" by Heinrich Meyr, Marc
00042      * Moeneclaey, & Stefan Fechtel.  ISBN 0-471-50275-8.
00043      */
00044     class DIGITAL_API clock_recovery_mm_ff : virtual public block
00045     {
00046     public:
00047       // gr::digital::clock_recovery_mm_ff::sptr
00048       typedef boost::shared_ptr<clock_recovery_mm_ff> sptr;
00049 
00050       /*!
00051        * Make a M&M clock recovery block.
00052        *
00053        * \param omega Initial estimate of samples per symbol
00054        * \param gain_omega Gain setting for omega update loop
00055        * \param mu Initial estimate of phase of sample
00056        * \param gain_mu Gain setting for mu update loop
00057        * \param omega_relative_limit limit on omega
00058        */
00059       static sptr make(float omega, float gain_omega,
00060                        float mu, float gain_mu,
00061                        float omega_relative_limit);
00062       
00063       virtual float mu() const = 0;
00064       virtual float omega() const = 0;
00065       virtual float gain_mu() const = 0;
00066       virtual float gain_omega() const = 0;
00067 
00068       virtual void set_verbose(bool verbose) = 0;
00069       virtual void set_gain_mu (float gain_mu) = 0;
00070       virtual void set_gain_omega (float gain_omega) = 0;
00071       virtual void set_mu (float mu) = 0;
00072       virtual void set_omega (float omega) = 0;
00073     };
00074 
00075   } /* namespace digital */
00076 } /* namespace gr */
00077 
00078 #endif /* INCLUDED_DIGITAL_CLOCK_RECOVERY_MM_FF_H */