GNU Radio's GSM Package: receiver.h Source File

GNU Radio's GSM Package

receiver.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3 * @file
4 * @author (C) 2014-2016 by Piotr Krysik <ptrkrysik@gmail.com>
5 * @section LICENSE
6 *
7 * Gr-gsm 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 * Gr-gsm 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 gr-gsm; 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
24 #ifndef INCLUDED_GSM_RECEIVER_H
25 #define INCLUDED_GSM_RECEIVER_H
26
27 #include <grgsm/api.h>
28 #include <gnuradio/block.h>
29 #include <gnuradio/sync_block.h>
30 #include <vector>
31
32 namespace gr {
33 namespace gsm {
34
35 /*!
36 * \brief <+description of block+>
37 * \ingroup gsm
38 *
39 */
40 class GRGSM_API receiver : virtual public sync_block
41 {
42 public:
43 typedef boost::shared_ptr<receiver> sptr;
44
45 /*!
46 * \brief Return a shared_ptr to a new instance of gsm::receiver.
47 *
48 * To avoid accidental use of raw pointers, gsm::receiver's
49 * constructor is in a private implementation
50 * class. gsm::receiver::make is the public interface for
51 * creating new instances.
52 */
53 static sptr make(int osr, const std::vector<int> &cell_allocation, const std::vector<int> &seq_nums, bool process_uplink=false);
54
55 virtual void set_cell_allocation(const std::vector<int> &cell_allocation) = 0;
56 virtual void set_tseq_nums(const std::vector<int> & tseq_nums) = 0;
57 virtual void reset() = 0;
58 };
59
60 } // namespace gsm
61 } // namespace gr
62
63 #endif /* INCLUDED_GSM_RECEIVER_H */
64
api.h
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::receiver::sptr
boost::shared_ptr< receiver > sptr
Definition: receiver.h:43
gr
Definition: constants.h:29
gr::gsm::receiver
<+description of block+>
Definition: receiver.h:40