Imported Upstream version 3.2.2
[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 3, 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 /*!
29  * \brief VCO - Voltage controlled oscillator
30  * \ingroup misc
31  *
32  * \param sampling_rate         sampling rate (Hz)
33  * \param sensitivity           units are radians/sec/volt
34  * \param amplitude             output amplitude
35  */
36 class gr_vco_f;
37 typedef boost::shared_ptr<gr_vco_f> gr_vco_f_sptr;
38
39
40 gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amplitude);
41
42 /*!
43  * \brief VCO - Voltage controlled oscillator
44  * \ingroup modulator_blk
45  *
46  * input: float stream of control voltages; output: float oscillator output
47  */
48 class gr_vco_f : public gr_sync_block
49 {
50   friend gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amplitude);
51
52   /*!
53    * \brief VCO - Voltage controlled oscillator
54    *
55    * \param sampling_rate       sampling rate (Hz)
56    * \param sensitivity         units are radians/sec/volt
57    * \param amplitude           output amplitude
58    */
59   gr_vco_f(double sampling_rate, double sensitivity, double amplitude);
60
61   double        d_sampling_rate;
62   double        d_sensitivity;
63   double        d_amplitude;
64   double        d_k;
65   gr_fxpt_vco   d_vco;
66
67 public:
68
69   int work (int noutput_items,
70             gr_vector_const_void_star &input_items,
71             gr_vector_void_star &output_items);
72 };
73
74 #endif /* INCLUDED_GR_VCO_F_H */