GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
atsc_rs_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 * 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_DTV_ATSC_RS_DECODER_H
24#define INCLUDED_DTV_ATSC_RS_DECODER_H
25
26#include <gnuradio/dtv/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace dtv {
31
32/*!
33 * \brief ATSC Receiver Reed-Solomon Decoder
34 *
35 * \ingroup dtv_atsc
36 */
38{
39public:
40 // gr::dtv::atsc_rs_decoder::sptr
41 typedef boost::shared_ptr<atsc_rs_decoder> sptr;
42
43 /*!
44 * Returns the number of errors corrected by the decoder.
45 */
46 virtual int num_errors_corrected() const = 0;
47
48 /*!
49 * Returns the number of bad packets rejected by the decoder.
50 */
51 virtual int num_bad_packets() const = 0;
52
53 /*!
54 * Returns the total number of packets seen by the decoder.
55 */
56 virtual int num_packets() const = 0;
57
58 /*!
59 * \brief Make a new instance of gr::dtv::atsc_rs_decoder.
60 */
61 static sptr make();
62};
63
64} /* namespace dtv */
65} /* namespace gr */
66
67#endif /* INCLUDED_DTV_ATSC_RS_DECODER_H */
ATSC Receiver Reed-Solomon Decoder.
Definition: atsc_rs_decoder.h:38
virtual int num_errors_corrected() const =0
virtual int num_packets() const =0
boost::shared_ptr< atsc_rs_decoder > sptr
Definition: atsc_rs_decoder.h:41
static sptr make()
Make a new instance of gr::dtv::atsc_rs_decoder.
virtual int num_bad_packets() const =0
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define DTV_API
Definition: gr-dtv/include/gnuradio/dtv/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45