GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
repetition_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_REPETITION_ENCODER_H
24#define INCLUDED_FEC_REPETITION_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 Repetition Encoding class.
37 * \ingroup error_coding_blk
38 *
39 * \details
40 * A repetition encoder class that repeats each input bit \p rep
41 * times. To decode, take a majority vote over the number of
42 * repetitions.
43 */
45{
46public:
47 /*!
48 * Build a repetition 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 rep Repetition rate; encoder rate is rep bits out
54 * for each input bit.
55 */
56 static generic_encoder::sptr make(int frame_size, int rep);
57
58 /*!
59 * Sets the uncoded frame size to \p frame_size. If \p
60 * frame_size is greater than the value given to the
61 * constructor, the frame size will be capped by that initial
62 * value and this function will return false. Otherwise, it
63 * returns true.
64 */
65 virtual bool set_frame_size(unsigned int frame_size) = 0;
66
67 /*!
68 * Returns the coding rate of this encoder.
69 */
70 virtual double rate() = 0;
71};
72
73} /* namespace code */
74} /* namespace fec */
75} /* namespace gr */
76
77#endif /* INCLUDED_FEC_REPETITION_ENCODER_H */
Repetition Encoding class.
Definition repetition_encoder.h:45
static generic_encoder::sptr make(int frame_size, int rep)
virtual bool set_frame_size(unsigned int frame_size)=0
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
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46