GNU Radio 3.6.5 C++ API

vco_f.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_VCO_F_H
00024 #define INCLUDED_GR_VCO_F_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief VCO - Voltage controlled oscillator
00034      * \ingroup modulators_blk
00035      * \ingroup waveform_generators_blk
00036      *
00037      * \details
00038      * input: float stream of control voltages; output: float oscillator output
00039      */
00040     class BLOCKS_API vco_f : virtual public gr_sync_block
00041     {
00042     public:
00043       // gr::blocks::vco_f::sptr
00044       typedef boost::shared_ptr<vco_f> sptr;
00045 
00046       /*!
00047        * \brief VCO - Voltage controlled oscillator
00048        *
00049        * \param sampling_rate sampling rate (Hz)
00050        * \param sensitivity units are radians/sec/volt
00051        * \param amplitude output amplitude
00052        */
00053       static sptr make(double sampling_rate, double sensitivity, double amplitude);
00054     };
00055 
00056   } /* namespace blocks */
00057 } /* namespace gr */
00058 
00059 #endif /* INCLUDED_GR_VCO_F_H */