GNU Radio 3.5.1 C++ API
gr_simple_framer.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004 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 <gr_core_api.h>
00027 #include <gr_block.h>
00028 
00029 class gr_simple_framer;
00030 typedef boost::shared_ptr<gr_simple_framer> gr_simple_framer_sptr;
00031 
00032 GR_CORE_API gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize);
00033 
00034 /*!
00035  * \brief add sync field, seq number and command field to payload
00036  * \ingroup sync_blk
00037  */
00038 class GR_CORE_API gr_simple_framer : public gr_block
00039 {
00040   int   d_seqno;
00041   int   d_payload_bytesize;
00042   int   d_input_block_size;     // bytes
00043   int   d_output_block_size;    // bytes
00044 
00045   friend GR_CORE_API gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize);
00046   gr_simple_framer (int payload_bytesize);
00047 
00048  public:
00049   void forecast (int noutput_items,
00050                  gr_vector_int &ninput_items_required);
00051 
00052   int general_work (int noutput_items,
00053                     gr_vector_int &ninput_items,
00054                     gr_vector_const_void_star &input_items,
00055                     gr_vector_void_star &output_items);
00056 };
00057 
00058 
00059 #endif /* INCLUDED_GR_SIMPLE_FRAMER_H */