GNU Radio C++ API Reference: dummy_decoder.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
dummy_decoder.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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_FEC_DUMMY_DECODER_H
12#define INCLUDED_FEC_DUMMY_DECODER_H
13
14#include <gnuradio/fec/api.h>
15#include <gnuradio/fec/generic_decoder.h>
16#include <map>
17#include <string>
18
19namespace gr {
20namespace fec {
21namespace code {
22
23/*!
24 * \brief Dummy Decoding class.
25 * \ingroup error_coding_blk
26 *
27 * \details
28 * A dummy decoder class that simply passes the input to the
29 * output. It is meant to allow us to easily use the FEC API
30 * encoder and decoder blocks in an application with no coding.
31 */
32 class FEC_API dummy_decoder : virtual public generic_decoder
33{
34public:
35 /*!
36 * Build a dummy decoding FEC API object.
37 *
38 * \param frame_size Number of bits per frame. If using in the
39 * tagged stream style, this is the maximum allowable
40 * number of bits per frame.
41 */
42 static generic_decoder::sptr make(int frame_size);
43
44 /*!
45 * Sets the uncoded frame size to \p frame_size. If \p
46 * frame_size is greater than the value given to the
47 * constructor, the frame size will be capped by that initial
48 * value and this function will return false. Otherwise, it
49 * returns true.
50 */
51 bool set_frame_size(unsigned int frame_size) override = 0;
52
53 /*!
54 * Returns the coding rate of this encoder (it will always be 1).
55 */
56 double rate() override = 0;
57};
58
59} /* namespace code */
60} /* namespace fec */
61} /* namespace gr */
62
63#endif /* INCLUDED_FEC_DUMMY_DECODER_H */
gr::fec::code::dummy_decoder
Dummy Decoding class.
Definition dummy_decoder.h:33
gr::fec::code::dummy_decoder::make
static generic_decoder::sptr make(int frame_size)
gr::fec::code::dummy_decoder::set_frame_size
bool set_frame_size(unsigned int frame_size) override=0
gr::fec::code::dummy_decoder::rate
double rate() override=0
gr::fec::generic_decoder::generic_decoder
generic_decoder(void)
Definition generic_decoder.h:64
gr::fec::generic_decoder::sptr
std::shared_ptr< generic_decoder > sptr
Definition generic_decoder.h:62
generic_decoder.h
api.h
FEC_API
#define FEC_API
Definition gr-fec/include/gnuradio/fec/api.h:18
gr::fec::code
Definition cc_decoder.h:22
gr::fec
Definition async_decoder.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29