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