GNU Radio 3.7.1 C++ API
crc32_bb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /* 
00003  * Copyright 2013 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 
00024 #ifndef INCLUDED_DIGITAL_CRC32_BB_H
00025 #define INCLUDED_DIGITAL_CRC32_BB_H
00026 
00027 #include <gnuradio/digital/api.h>
00028 #include <gnuradio/tagged_stream_block.h>
00029 
00030 namespace gr {
00031   namespace digital {
00032 
00033     /*!
00034      * \brief Byte-stream CRC block
00035      * \ingroup packet_operators_blk
00036      *
00037      * \details
00038      * Input: stream of bytes, which form a packet. The first byte of the packet
00039      * has a tag with key "length" and the value being the number of bytes in the
00040      * packet.
00041      *
00042      * Output: The same bytes as incoming, but trailing a CRC32 of the packet.
00043      * The tag is re-set to the new length.
00044      */
00045     class DIGITAL_API crc32_bb : virtual public tagged_stream_block
00046     {
00047      public:
00048       typedef boost::shared_ptr<crc32_bb> sptr;
00049 
00050       /*!
00051        * \param check Set to true if you want to check CRC, false to create CRC.
00052        * \param lengthtagname Length tag key
00053        */
00054       static sptr make(bool check=false, const std::string& lengthtagname="packet_len");
00055     };
00056 
00057   } // namespace digital
00058 } // namespace gr
00059 
00060 #endif /* INCLUDED_DIGITAL_CRC32_BB_H */
00061