GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
pn_correlator_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,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_GR_PN_CORRELATOR_CC_H
24 #define INCLUDED_GR_PN_CORRELATOR_CC_H
25 
26 #include <gnuradio/digital/api.h>
28 
29 namespace gr {
30  namespace digital {
31 
32  /*!
33  * \brief PN code sequential search correlator
34  * \ingroup synchronizers_blk
35  *
36  * \details
37  * Receives complex baseband signal, outputs complex correlation
38  * against reference PN code, one sample per PN code period. The
39  * PN sequence is generated using a GLFSR.
40  */
42  {
43  public:
44  // gr::digital::pn_correlator_cc::sptr
45  typedef boost::shared_ptr<pn_correlator_cc> sptr;
46 
47  /*!
48  * \brief Make PN code sequential search correlator block.
49  *
50  * \param degree Degree of shift register must be in [1, 32]. If mask
51  * is 0, the degree determines a default mask (see
52  * digital_impl_glfsr.cc for the mapping).
53  * \param mask Allows a user-defined bit mask for indexes of the shift
54  * register to feed back.
55  * \param seed Initial setting for values in shift register.
56  */
57  static sptr make(int degree, int mask=0, int seed=1);
58  };
59 
60  } /* namespace digital */
61 } /* namespace gr */
62 
63 #endif /* INCLUDED_GR_PN_CORRELATOR_CC_H */
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: logger.h:695
synchronous N:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_decimator.h:37
boost::shared_ptr< pn_correlator_cc > sptr
Definition: pn_correlator_cc.h:45
PN code sequential search correlator.
Definition: pn_correlator_cc.h:41