GNU Radio's GSM Package
controlled_fractional_resampler_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /* @file
3  * @author (C) 2016 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 
24 #ifndef INCLUDED_GRGSM_CONTROLLED_FRACTIONAL_RESAMPLER_CC_H
25 #define INCLUDED_GRGSM_CONTROLLED_FRACTIONAL_RESAMPLER_CC_H
26 
27 #include <grgsm/api.h>
28 #include <gnuradio/block.h>
29 //#include <gnuradio/filter/fractional_resampler_cc.h>
30 
31 namespace gr {
32  namespace gsm {
33 
34  /*!
35  * \brief <+description of block+>
36  * \ingroup grgsm
37  *
38  */
39  class GRGSM_API controlled_fractional_resampler_cc : virtual public block
40  {
41  public:
42  typedef boost::shared_ptr<controlled_fractional_resampler_cc> sptr;
43 
44  /*!
45  * \brief Return a shared_ptr to a new instance of grgsm::controlled_fractional_resampler_cc.
46  *
47  * To avoid accidental use of raw pointers, grgsm::controlled_fractional_resampler_cc's
48  * constructor is in a private implementation
49  * class. grgsm::controlled_fractional_resampler_cc::make is the public interface for
50  * creating new instances.
51  */
52  static sptr make(float phase_shift, float resamp_ratio);
53 
54  virtual float mu() const = 0;
55  virtual float resamp_ratio() const = 0;
56  virtual void set_mu (float mu) = 0;
57  virtual void set_resamp_ratio(float resamp_ratio) = 0;
58  };
59 
60  } // namespace gsm
61 } // namespace gr
62 
63 #endif /* INCLUDED_GRGSM_CONTROLLED_FRACTIONAL_RESAMPLER_CC_H */
64 
gr::gsm::controlled_fractional_resampler_cc::sptr
boost::shared_ptr< controlled_fractional_resampler_cc > sptr
Definition: controlled_fractional_resampler_cc.h:42
gr::gsm::controlled_fractional_resampler_cc
<+description of block+>
Definition: controlled_fractional_resampler_cc.h:39
gr
Definition: constants.h:29
GRGSM_API
#define GRGSM_API
Definition: api.h:31
api.h