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

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

Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_DTV_ATSC_RS_DECODER_H
12#define INCLUDED_DTV_ATSC_RS_DECODER_H
13
14#include <gnuradio/dtv/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace dtv {
19
20/*!
21 * \brief ATSC Receiver Reed-Solomon Decoder
22 *
23 * \ingroup dtv_atsc
24 */
25 class DTV_API atsc_rs_decoder : virtual public gr::sync_block
26{
27public:
28 // gr::dtv::atsc_rs_decoder::sptr
29 typedef std::shared_ptr<atsc_rs_decoder> sptr;
30
31 /*!
32 * Returns the number of errors corrected by the decoder.
33 */
34 virtual int num_errors_corrected() const = 0;
35
36 /*!
37 * Returns the number of bad packets rejected by the decoder.
38 */
39 virtual int num_bad_packets() const = 0;
40
41 /*!
42 * Returns the total number of packets seen by the decoder.
43 */
44 virtual int num_packets() const = 0;
45
46 /*!
47 * \brief Make a new instance of gr::dtv::atsc_rs_decoder.
48 */
49 static sptr make();
50};
51
52} /* namespace dtv */
53} /* namespace gr */
54
55#endif /* INCLUDED_DTV_ATSC_RS_DECODER_H */
gr::dtv::atsc_rs_decoder
ATSC Receiver Reed-Solomon Decoder.
Definition atsc_rs_decoder.h:26
gr::dtv::atsc_rs_decoder::sptr
std::shared_ptr< atsc_rs_decoder > sptr
Definition atsc_rs_decoder.h:29
gr::dtv::atsc_rs_decoder::num_errors_corrected
virtual int num_errors_corrected() const =0
gr::dtv::atsc_rs_decoder::num_packets
virtual int num_packets() const =0
gr::dtv::atsc_rs_decoder::make
static sptr make()
Make a new instance of gr::dtv::atsc_rs_decoder.
gr::dtv::atsc_rs_decoder::num_bad_packets
virtual int num_bad_packets() const =0
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
DTV_API
#define DTV_API
Definition gr-dtv/include/gnuradio/dtv/api.h:18
gr::dtv
Definition atsc_consts.h:17
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h