GNU Radio's GSM Package
burst_type_filter.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /* @file
3  * @author (C) 2017 by Piotr Krysik <ptrkrysik@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_TYPE_FILTER_H
24 #define INCLUDED_GSM_BURST_TYPE_FILTER_H
25 
26 #include <grgsm/api.h>
27 #include <gnuradio/block.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_type_filter : virtual public gr::block
39  {
40  public:
41  typedef boost::shared_ptr<burst_type_filter> sptr;
42 
43  /*!
44  * \brief Return a shared_ptr to a new instance of grgsm::burst_type_filter.
45  *
46  * To avoid accidental use of raw pointers, grgsm::burst_type_filter's
47  * constructor is in a private implementation
48  * class. grgsm::burst_type_filter::make is the public interface for
49  * creating new instances.
50  */
51 
52  static sptr make(const std::vector<uint8_t> & selected_burst_types);
53 
54  /* External API */
55  /* Filtering policy */
56  virtual filter_policy get_policy(void) = 0;
57  virtual filter_policy set_policy(filter_policy policy) = 0;
58  virtual void set_selected_burst_types(const std::vector<uint8_t> & selected_burst_types) = 0;
59  };
60  } // namespace gsm
61 } // namespace gr
62 
63 #endif /* INCLUDED_GSM_BURST_TYPE_FILTER_H */
gr::gsm::burst_type_filter::make
static sptr make(const std::vector< uint8_t > &selected_burst_types)
Return a shared_ptr to a new instance of grgsm::burst_type_filter.
gr::gsm::burst_type_filter::set_policy
virtual filter_policy set_policy(filter_policy policy)=0
gr::gsm::filter_policy
filter_policy
Definition: common.h:29
gr::gsm::burst_type_filter::set_selected_burst_types
virtual void set_selected_burst_types(const std::vector< uint8_t > &selected_burst_types)=0
gr::gsm::burst_type_filter::sptr
boost::shared_ptr< burst_type_filter > sptr
Definition: burst_type_filter.h:41
gr::gsm::burst_type_filter
<+description of block+>
Definition: burst_type_filter.h:39
common.h
gr
Definition: constants.h:29
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::burst_type_filter::get_policy
virtual filter_policy get_policy(void)=0
api.h