GNU Radio 3.6.5.1 C++ API
digital_simple_framer.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_GR_SIMPLE_FRAMER_H
24 #define INCLUDED_GR_SIMPLE_FRAMER_H
25 
26 #include <digital_api.h>
27 #include <gr_block.h>
28 
31 
33 
34 /*!
35  * \brief add sync field, seq number and command field to payload
36  * \ingroup packet_operators_blk
37  * \ingroup deprecated_blk
38  *
39  * \details
40  * Takes in enough samples to create a full output frame. The frame is
41  * prepended with the GRSF_SYNC (defind in
42  * digital_simple_framer_sync.h) and an 8-bit sequence number.
43  *
44  * \param payload_bytesize The size of the payload in bytes.
45  */
47 {
48  int d_seqno;
49  int d_payload_bytesize;
50  int d_input_block_size; // bytes
51  int d_output_block_size; // bytes
52 
54  digital_make_simple_framer(int payload_bytesize);
55  digital_simple_framer(int payload_bytesize);
56 
57  public:
58  void forecast(int noutput_items,
59  gr_vector_int &ninput_items_required);
60 
61  int general_work(int noutput_items,
62  gr_vector_int &ninput_items,
63  gr_vector_const_void_star &input_items,
64  gr_vector_void_star &output_items);
65 };
66 
67 
68 #endif /* INCLUDED_GR_SIMPLE_FRAMER_H */