GNU Radio 3.7.1 C++ API
correlate_access_code_bb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2006,2011,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_DIGITAL_CORRELATE_ACCESS_CODE_BB_H
00024 #define INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_BB_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/sync_block.h>
00028 #include <string>
00029 
00030 namespace gr {
00031   namespace digital {
00032 
00033     /*!
00034      * \brief Examine input for specified access code, one bit at a time.
00035      * \ingroup packet_operators_blk
00036      * \ingroup deprecated_blk
00037      *
00038      * \details
00039      * input:  stream of bits, 1 bit per input byte (data in LSB)
00040      * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit)
00041      *
00042      * Each output byte contains two valid bits, the data bit, and the
00043      * flag bit. The LSB (bit 0) is the data bit, and is the original
00044      * input data, delayed 64 bits. Bit 1 is the flag bit and is 1 if
00045      * the corresponding data bit is the first data bit following the
00046      * access code. Otherwise the flag bit is 0.
00047      */
00048     class DIGITAL_API correlate_access_code_bb : virtual public sync_block
00049     {
00050     public:
00051       // gr::digital::correlate_access_code_bb::sptr
00052       typedef boost::shared_ptr<correlate_access_code_bb> sptr;
00053 
00054       /*!
00055        * Make a correlate_access_code block.
00056        *
00057        * \param access_code is represented with 1 byte per bit,
00058        *                    e.g., "010101010111000100" 
00059        * \param threshold maximum number of bits that may be wrong
00060        */
00061       static sptr make(const std::string &access_code, int threshold);
00062 
00063       /*!
00064        * Set a new access code.
00065        *
00066        * \param access_code is represented with 1 byte per bit,
00067        *                    e.g., "010101010111000100"
00068        */
00069       virtual bool set_access_code(const std::string &access_code) = 0;
00070     };
00071 
00072   } /* namespace digital */
00073 } /* namespace gr */
00074 
00075 #endif /* INCLUDED_DIGITAL_CORRELATE_ACCESS_CODE_BB_H */