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_DECODER_H
24 #define INCLUDED_FEC_DUMMY_DECODER_H
25 
26 #include <gnuradio/fec/api.h>
27 #include <gnuradio/fec/generic_decoder.h>
28 #include <map>
29 #include <string>
30 
31 namespace gr {
32 namespace fec {
33 namespace code {
34 
35 /*!
36  * \brief Dummy Decoding class.
37  * \ingroup error_coding_blk
38  *
39  * \details
40  * A dummy decoder 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  */
44 class FEC_API dummy_decoder : virtual public generic_decoder
45 {
46 public:
47     /*!
48      * Build a dummy decoding 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      */
54     static generic_decoder::sptr make(int frame_size);
55 
56     /*!
57      * Sets the uncoded frame size to \p frame_size. If \p
58      * frame_size is greater than the value given to the
59      * constructor, the frame size will be capped by that initial
60      * value and this function will return false. Otherwise, it
61      * returns true.
62      */
63     virtual bool set_frame_size(unsigned int frame_size) = 0;
64 
65     /*!
66      * Returns the coding rate of this encoder (it will always be 1).
67      */
68     virtual double rate() = 0;
69 };
70 
71 } /* namespace code */
72 } /* namespace fec */
73 } /* namespace gr */
74 
75 #endif /* INCLUDED_FEC_DUMMY_DECODER_H */
76