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

GNU Radio's GSM Package

burst_fnr_filter.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3 * @file
4 * @author (C) 2015 by Roman Khassraf <rkhassraf@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_BURST_FNR_FILTER_H
25 #define INCLUDED_GSM_BURST_FNR_FILTER_H
26
27 #include <grgsm/api.h>
28 #include <gnuradio/block.h>
29 #include <grgsm/flow_control/common.h>
30
31 namespace gr {
32 namespace gsm {
33
34 enum filter_mode
35 {
36 FILTER_LESS_OR_EQUAL,
37 FILTER_GREATER_OR_EQUAL
38 };
39
40 /*!
41 * \brief <+description of block+>
42 * \ingroup gsm
43 *
44 */
45 class GRGSM_API burst_fnr_filter : virtual public gr::block
46 {
47 public:
48 typedef boost::shared_ptr<burst_fnr_filter> sptr;
49
50 /*!
51 * \brief Return a shared_ptr to a new instance of gsm::burst_fnr_filter.
52 *
53 * To avoid accidental use of raw pointers, gsm::burst_fnr_filter's
54 * constructor is in a private implementation
55 * class. gsm::burst_fnr_filter::make is the public interface for
56 * creating new instances.
57 */
58 static sptr make(filter_mode mode, unsigned int fnr);
59
60 /* External API */
61 virtual unsigned int get_fn(void) = 0;
62 virtual unsigned int set_fn(unsigned int fn) = 0;
63
64 virtual filter_mode get_mode(void) = 0;
65 virtual filter_mode set_mode(filter_mode mode) = 0;
66
67 /* Filtering policy */
68 virtual filter_policy get_policy(void) = 0;
69 virtual filter_policy set_policy(filter_policy policy) = 0;
70 };
71
72 } // namespace gsm
73 } // namespace gr
74
75 #endif /* INCLUDED_GSM_BURST_FNR_FILTER_H */
gr::gsm::burst_fnr_filter::sptr
boost::shared_ptr< burst_fnr_filter > sptr
Definition: burst_fnr_filter.h:48
api.h
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::filter_mode
filter_mode
Definition: burst_fnr_filter.h:34
gr::gsm::FILTER_GREATER_OR_EQUAL
Definition: burst_fnr_filter.h:37
gr
Definition: constants.h:29
gr::gsm::burst_fnr_filter
<+description of block+>
Definition: burst_fnr_filter.h:45
common.h
gr::gsm::filter_policy
filter_policy
Definition: common.h:29
gr::gsm::FILTER_LESS_OR_EQUAL
Definition: burst_fnr_filter.h:36