Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_pn_correlator_cc.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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 <gr_sync_decimator.h>
27 #include <gri_glfsr.h>
28
29 class gr_pn_correlator_cc;
30 typedef boost::shared_ptr<gr_pn_correlator_cc> gr_pn_correlator_cc_sptr;
31
32 gr_pn_correlator_cc_sptr
33 gr_make_pn_correlator_cc(int degree, int mask=0, int seed=1);
34 /*!
35  * \brief PN code sequential search correlator
36  *
37  * \ingroup sync_blk
38  * Receives complex baseband signal, outputs complex correlation against
39  * reference PN code, one sample per PN code period
40  */
41
42 class gr_pn_correlator_cc : public gr_sync_decimator
43 {
44   friend gr_pn_correlator_cc_sptr gr_make_pn_correlator_cc(int degree, int mask, int seed);
45
46   int        d_len;
47   float      d_pn;
48   gri_glfsr *d_reference;
49
50  protected:
51   gr_pn_correlator_cc(int degree, int mask, int seed);
52
53  public:
54   virtual int work(int noutput_items,
55                    gr_vector_const_void_star &input_items,
56                    gr_vector_void_star &output_items);
57
58   ~gr_pn_correlator_cc();
59 };
60
61 #endif /* INCLUDED_GR_PN_CORRELATOR_CC_H */