GNU Radio 3.7.1 C++ API
scrambler_bb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2008,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_SCRAMBLER_BB_H
00024 #define INCLUDED_GR_SCRAMBLER_BB_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/sync_block.h>
00028 
00029 namespace gr {
00030   namespace digital {
00031 
00032     /*!
00033      * \brief Scramble an input stream using an LFSR.
00034      * \ingroup coding_blk
00035      *
00036      * \details
00037      * This block works on the LSB only of the input data stream,
00038      * i.e., on an "unpacked binary" stream, and produces the same
00039      * format on its output.
00040      */
00041     class DIGITAL_API scrambler_bb : virtual public sync_block
00042     {
00043     public:
00044       // gr::digital::scrambler_bb::sptr
00045       typedef boost::shared_ptr<scrambler_bb> sptr;
00046 
00047       /*!
00048        * Make a scramber block.
00049        *
00050        * \param mask     Polynomial mask for LFSR
00051        * \param seed     Initial shift register contents
00052        * \param len      Shift register length
00053        */
00054       static sptr make(int mask, int seed, int len);
00055     };
00056 
00057   } /* namespace digital */
00058 } /* namespace gr */
00059 
00060 #endif /* INCLUDED_GR_SCRAMBLER_BB_H */