GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
vco_f.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2013 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 
23 #ifndef INCLUDED_GR_VCO_F_H
24 #define INCLUDED_GR_VCO_F_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief VCO - Voltage controlled oscillator
34  * \ingroup modulators_blk
35  * \ingroup waveform_generators_blk
36  *
37  * \details
38  * input: float stream of control voltages; output: float oscillator output
39  */
40  class BLOCKS_API vco_f : virtual public sync_block
41  {
42  public:
43  // gr::blocks::vco_f::sptr
44  typedef boost::shared_ptr<vco_f> sptr;
45 
46  /*!
47  * \brief VCO - Voltage controlled oscillator
48  *
49  * \param sampling_rate sampling rate (Hz)
50  * \param sensitivity units are radians/sec/volt
51  * \param amplitude output amplitude
52  */
53  static sptr make(double sampling_rate, double sensitivity, double amplitude);
54  };
55 
56  } /* namespace blocks */
57 } /* namespace gr */
58 
59 #endif /* INCLUDED_GR_VCO_F_H */
boost::shared_ptr< vco_f > sptr
Definition: vco_f.h:44
Include this header to use the message passing features.
Definition: logger.h:695
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
VCO - Voltage controlled oscillator.
Definition: vco_f.h:40