GNU Radio's LORA Package
encode.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2016 Bastille Networks.
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_ENCODE_H
23#define INCLUDED_LORA_ENCODE_H
24
25#include <lora/api.h>
26#include <gnuradio/block.h>
27#include <lora/lora.h>
28
29namespace gr {
30 namespace lora {
31
32 /*!
33 * \brief <+description of block+>
34 * \ingroup lora
35 *
36 */
37 class LORA_API encode : virtual public gr::block
38 {
39 public:
40 typedef boost::shared_ptr<encode> sptr;
41
42 /*!
43 * \brief Return a shared_ptr to a new instance of lora::encode.
44 *
45 * To avoid accidental use of raw pointers, lora::encode's
46 * constructor is in a private implementation
47 * class. lora::encode::make is the public interface for
48 * creating new instances.
49 */
50 static sptr make( short spreading_factor,
51 short code_rate,
52 bool low_data_rate,
53 bool header);
54 };
55
56 } // namespace lora
57} // namespace gr
58
59#endif /* INCLUDED_LORA_ENCODE_H */
60
#define LORA_API
Definition api.h:30
<+description of block+>
Definition encode.h:38
boost::shared_ptr< encode > sptr
Definition encode.h:40
static sptr make(short spreading_factor, short code_rate, bool low_data_rate, bool header)
Return a shared_ptr to a new instance of lora::encode.
Definition decode.h:31