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

GNU Radio's GSM Package

burst_timeslot_filter.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /* @file
3 * @author (C) 2015 by Roman Khassraf <rkhassraf@gmail.com>
4 * @section LICENSE
5 *
6 * Gr-gsm is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * Gr-gsm is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with gr-gsm; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 *
21 */
22
23 #ifndef INCLUDED_GSM_BURST_TIMESLOT_FILTER_H
24 #define INCLUDED_GSM_BURST_TIMESLOT_FILTER_H
25
26 #include <grgsm/api.h>
27 #include <gnuradio/block.h>
28 #include <grgsm/flow_control/common.h>
29
30 namespace gr {
31 namespace gsm {
32
33 /*!
34 * \brief <+description of block+>
35 * \ingroup gsm
36 *
37 */
38 class GRGSM_API burst_timeslot_filter : virtual public gr::block
39 {
40 public:
41 typedef boost::shared_ptr<burst_timeslot_filter> sptr;
42
43 /*!
44 * \brief Return a shared_ptr to a new instance of grgsm::burst_timeslot_filter.
45 *
46 * To avoid accidental use of raw pointers, grgsm::burst_timeslot_filter's
47 * constructor is in a private implementation
48 * class. grgsm::burst_timeslot_filter::make is the public interface for
49 * creating new instances.
50 */
51 static sptr make(unsigned int timeslot);
52
53 /* External API */
54 virtual unsigned int get_tn(void) = 0;
55 virtual unsigned int set_tn(unsigned int tn) = 0;
56
57 /* Filtering policy */
58 virtual filter_policy get_policy(void) = 0;
59 virtual filter_policy set_policy(filter_policy policy) = 0;
60 };
61 } // namespace gsm
62 } // namespace gr
63
64 #endif /* INCLUDED_GSM_BURST_TIMESLOT_FILTER_H */
api.h
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::burst_timeslot_filter::sptr
boost::shared_ptr< burst_timeslot_filter > sptr
Definition: burst_timeslot_filter.h:41
gr::gsm::burst_timeslot_filter
<+description of block+>
Definition: burst_timeslot_filter.h:38
gr
Definition: constants.h:29
timeslot
uint8_t timeslot
Definition: gsmtap.h:55
common.h
gr::gsm::filter_policy
filter_policy
Definition: common.h:29