GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
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 <gnuradio/block.h>
28
29namespace gr {
30namespace digital {
31
32/*!
33 * \brief add sync field, seq number and command field to payload
34 * \ingroup packet_operators_blk
35 * \ingroup deprecated_blk
36 *
37 * \details
38 * Takes in enough samples to create a full output frame. The
39 * frame is prepended with the GRSF_SYNC (defined in
40 * simple_framer_sync.h) and an 8-bit sequence number.
41 */
42class DIGITAL_API simple_framer : virtual public block
43{
44public:
45 // gr::digital::simple_framer::sptr
46 typedef boost::shared_ptr<simple_framer> sptr;
47
48 /*!
49 * Make a simple_framer block.
50 *
51 * \param payload_bytesize The size of the payload in bytes.
52 */
53 static sptr make(int payload_bytesize);
54};
55
56} /* namespace digital */
57} /* namespace gr */
58
59#endif /* INCLUDED_GR_SIMPLE_FRAMER_H */
The abstract base class for all 'terminal' processing blocks.
Definition block.h:72
add sync field, seq number and command field to payload
Definition simple_framer.h:43
boost::shared_ptr< simple_framer > sptr
Definition simple_framer.h:46
static sptr make(int payload_bytesize)
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46