GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
dummy_encoder.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2014 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_FEC_DUMMY_ENCODER_H
24#define INCLUDED_FEC_DUMMY_ENCODER_H
25
26#include <gnuradio/fec/api.h>
28#include <map>
29#include <string>
30
31namespace gr {
32namespace fec {
33namespace code {
34
35/*!
36 * \brief Dummy Encoding class.
37 * \ingroup error_coding_blk
38 *
39 * \details
40 * A dummy encoder class that simply passes the input to the
41 * output. It is meant to allow us to easily use the FEC API
42 * encoder and decoder blocks in an application with no coding.
43 */
45{
46public:
47 /*!
48 * Build a dummy encoding FEC API object.
49 *
50 * \param frame_size Number of bits per frame. If using in the
51 * tagged stream style, this is the maximum allowable
52 * number of bits per frame.
53 * \param pack Determines how to handle the input data stream
54 * as packed or unpacked bits. If set to True, the
55 * encoder's get_input_conversion will be set to
56 * 'pack', meaning that the data must be packed before
57 * being sent to this encoder. Generally handled
58 * through an extended encoder interface.
59 * \param packed_bits Determines how the output data stream is
60 * handled. If set to True, the encoder's
61 * get_output_conversion returns 'packed_bits', meaning
62 * that the output data of the encoder is packed and
63 * should be unpacked. Generally handled through an
64 * extended encoder interface.
65 */
67 make(int frame_size, bool pack = false, bool packed_bits = false);
68
69 /*!
70 * Sets the uncoded frame size to \p frame_size. If \p
71 * frame_size is greater than the value given to the
72 * constructor, the frame size will be capped by that initial
73 * value and this function will return false. Otherwise, it
74 * returns true.
75 */
76 virtual bool set_frame_size(unsigned int frame_size) = 0;
77
78 /*!
79 * Returns the coding rate of this encoder (it will always be 1).
80 */
81 virtual double rate() = 0;
82};
83
84} /* namespace code */
85} /* namespace fec */
86} /* namespace gr */
87
88#endif /* INCLUDED_FEC_DUMMY_ENCODER_H */
Dummy Encoding class.
Definition: dummy_encoder.h:45
virtual double rate()=0
virtual bool set_frame_size(unsigned int frame_size)=0
static generic_encoder::sptr make(int frame_size, bool pack=false, bool packed_bits=false)
Definition: generic_encoder.h:35
boost::shared_ptr< generic_encoder > sptr
Definition: generic_encoder.h:49
#define FEC_API
Definition: gr-fec/include/gnuradio/fec/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45