GNU Radio Manual and C++ API Reference  3.7.4.1
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
scrambler_bb.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008,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_SCRAMBLER_BB_H
24 #define INCLUDED_GR_SCRAMBLER_BB_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace digital {
31 
32  /*!
33  * \brief Scramble an input stream using an LFSR.
34  * \ingroup coding_blk
35  *
36  * \details
37  * This block works on the LSB only of the input data stream,
38  * i.e., on an "unpacked binary" stream, and produces the same
39  * format on its output.
40  */
41  class DIGITAL_API scrambler_bb : virtual public sync_block
42  {
43  public:
44  // gr::digital::scrambler_bb::sptr
46 
47  /*!
48  * Make a scramber block.
49  *
50  * \param mask Polynomial mask for LFSR
51  * \param seed Initial shift register contents
52  * \param len Shift register length
53  */
54  static sptr make(int mask, int seed, int len);
55  };
56 
57  } /* namespace digital */
58 } /* namespace gr */
59 
60 #endif /* INCLUDED_GR_SCRAMBLER_BB_H */
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
boost::shared_ptr< scrambler_bb > sptr
Definition: scrambler_bb.h:45
Scramble an input stream using an LFSR.
Definition: scrambler_bb.h:41
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37