GNU Radio's LORA_SDR Package
whitening.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 #ifndef INCLUDED_LORA_SDR_WHITENING_H
22 #define INCLUDED_LORA_SDR_WHITENING_H
23 
24 #include <gnuradio/sync_block.h>
25 #include <lora_sdr/api.h>
26 
27 namespace gr {
28 namespace lora_sdr {
29 
30 /*!
31  * \brief Whiten the input data
32  * For more information about the implementation visit whitening_impl
33  * \ingroup lora_sdr
34  *
35  */
36 class LORA_SDR_API whitening : virtual public gr::sync_block {
37 public:
38  typedef std::shared_ptr<whitening> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of lora_sdr::whitening.
42  *
43  * To avoid accidental use of raw pointers, lora_sdr::whitening's
44  * constructor is in a private implementation
45  * class. lora_sdr::whitening::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make();
49 };
50 
51 } // namespace lora_sdr
52 } // namespace gr
53 
54 #endif /* INCLUDED_LORA_SDR_WHITENING_H */
LORA_SDR_API
#define LORA_SDR_API
Definition: api.h:19
gr
Definition: add_crc.h:28
gr::lora_sdr::whitening::sptr
std::shared_ptr< whitening > sptr
Definition: whitening.h:38
gr::lora_sdr::whitening
Whiten the input data For more information about the implementation visit whitening_impl.
Definition: whitening.h:36
api.h