GNU Radio 3.7.1 C++ API
simple_framer.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,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_SIMPLE_FRAMER_H
00024 #define INCLUDED_GR_SIMPLE_FRAMER_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/block.h>
00028 
00029 namespace gr {
00030   namespace digital {
00031 
00032     /*!
00033      * \brief add sync field, seq number and command field to payload
00034      * \ingroup packet_operators_blk
00035      * \ingroup deprecated_blk
00036      *
00037      * \details
00038      * Takes in enough samples to create a full output frame. The
00039      * frame is prepended with the GRSF_SYNC (defind in
00040      * simple_framer_sync.h) and an 8-bit sequence number.
00041      */
00042     class DIGITAL_API simple_framer : virtual public block
00043     {
00044     public:
00045       // gr::digital::simple_framer::sptr
00046       typedef boost::shared_ptr<simple_framer> sptr;
00047 
00048       /*!
00049        * Make a simple_framer block.
00050        *
00051        * \param payload_bytesize The size of the payload in bytes.
00052        */
00053       static sptr make(int payload_bytesize);
00054     };
00055 
00056   } /* namespace digital */
00057 } /* namespace gr */
00058 
00059 #endif /* INCLUDED_GR_SIMPLE_FRAMER_H */