Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_vco_f.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio 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 2, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio 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 GNU Radio; 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 #ifndef INCLUDED_GR_VCO_F_H
23 #define INCLUDED_GR_VCO_F_H
24
25 #include <gr_sync_block.h>
26 #include <gr_fxpt_vco.h>
27
28 class gr_vco_f;
29 typedef boost::shared_ptr<gr_vco_f> gr_vco_f_sptr;
30
31 /*!
32  * \brief VCO - Voltage controlled oscillator
33  *
34  * \param sampling_rate         sampling rate (Hz)
35  * \param sensitivity           units are radians/sec/volt
36  * \param amplitude             output amplitude
37  */
38 gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amplitude);
39
40 /*!
41  * \brief VCO - Voltage controlled oscillator
42  * \ingroup block
43  *
44  * input: float stream of control voltages; output: float oscillator output
45  */
46 class gr_vco_f : public gr_sync_block
47 {
48   friend gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amplitude);
49
50   /*!
51    * \brief VCO - Voltage controlled oscillator
52    *
53    * \param sampling_rate       sampling rate (Hz)
54    * \param sensitivity         units are radians/sec/volt
55    * \param amplitude           output amplitude
56    */
57   gr_vco_f(double sampling_rate, double sensitivity, double amplitude);
58
59   double        d_sampling_rate;
60   double        d_sensitivity;
61   double        d_amplitude;
62   double        d_k;
63   gr_fxpt_vco   d_vco;
64
65 public:
66
67   int work (int noutput_items,
68             gr_vector_const_void_star &input_items,
69             gr_vector_void_star &output_items);
70 };
71
72 #endif /* INCLUDED_GR_VCO_F_H */