GNU Radio 3.7.1 C++ API
pn_correlator_cc.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2007,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_GR_PN_CORRELATOR_CC_H
00024 #define INCLUDED_GR_PN_CORRELATOR_CC_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/sync_decimator.h>
00028 
00029 namespace gr {
00030   namespace digital {
00031 
00032     /*!
00033      * \brief PN code sequential search correlator
00034      * \ingroup synchronizers_blk
00035      *
00036      * \details
00037      * Receives complex baseband signal, outputs complex correlation
00038      * against reference PN code, one sample per PN code period. The
00039      * PN sequence is generated using a GLFSR.
00040      */
00041     class DIGITAL_API pn_correlator_cc : virtual public sync_decimator
00042     {
00043     public:
00044       // gr::digital::pn_correlator_cc::sptr
00045       typedef boost::shared_ptr<pn_correlator_cc> sptr;
00046 
00047       /*!
00048        * \brief Make PN code sequential search correlator block.
00049        *
00050        * \param degree Degree of shift register must be in [1, 32]. If mask
00051        *               is 0, the degree determines a default mask (see
00052        *               digital_impl_glfsr.cc for the mapping).
00053        * \param mask   Allows a user-defined bit mask for indexes of the shift
00054        *               register to feed back.
00055        * \param seed   Initial setting for values in shift register.
00056        */
00057       static sptr make(int degree, int mask=0, int seed=1);
00058     };
00059 
00060   } /* namespace digital */
00061 } /* namespace gr */
00062 
00063 #endif /* INCLUDED_GR_PN_CORRELATOR_CC_H */