GNU Radio's LORA_SDR Package
hamming_dec.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2019 <+YOU OR YOUR COMPANY+>.
4 *
5 * This is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
8 * any later version.
9 *
10 * This software is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this software; see the file COPYING. If not, write to
17 * the Free Software Foundation, Inc., 51 Franklin Street,
18 * Boston, MA 02110-1301, USA.
19 */
20
21
22#ifndef INCLUDED_LORA_SDR_HAMMING_DEC_H
23#define INCLUDED_LORA_SDR_HAMMING_DEC_H
24
25#include <lora_sdr/api.h>
26#include <gnuradio/sync_block.h>
27
28namespace gr {
29 namespace lora_sdr {
30
31 /*!
32 * \brief Hamming decoding stage, decode the received payload.
33 * If necessary this block will preform error detection and correction using the hamming code parity bits.
34 * For more information about the implementation visit hamming_dec_impl
35 * \ingroup lora_sdr
36 *
37 */
38 class LORA_SDR_API hamming_dec : virtual public gr::sync_block
39 {
40 public:
41 typedef std::shared_ptr<hamming_dec> sptr;
42
43 /*!
44 * \brief Return a shared_ptr to a new instance of lora_sdr::hamming_dec.
45 *
46 * To avoid accidental use of raw pointers, lora_sdr::hamming_dec's
47 * constructor is in a private implementation
48 * class. lora_sdr::hamming_dec::make is the public interface for
49 * creating new instances.
50 */
51 static sptr make();
52 };
53
54 } // namespace lora_sdr
55} // namespace gr
56
57#endif /* INCLUDED_LORA_SDR_HAMMING_DEC_H */
58
#define LORA_SDR_API
Definition: api.h:19
Hamming decoding stage, decode the received payload. If necessary this block will preform error detec...
Definition: hamming_dec.h:39
static sptr make()
Return a shared_ptr to a new instance of lora_sdr::hamming_dec.
std::shared_ptr< hamming_dec > sptr
Definition: hamming_dec.h:41
Definition: add_crc.h:28