GNU Radio 3.6.5 C++ API

phase_modulator_fc.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2005,2006,2012 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_ANALOG_PHASE_MODULATOR_FC_H
00024 #define INCLUDED_ANALOG_PHASE_MODULATOR_FC_H
00025 
00026 #include <analog/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace analog {
00031 
00032     /*!
00033      * \brief Phase modulator block
00034      * \ingroup modulators_blk
00035      *
00036      * \details
00037      * output = complex(cos(in*sensitivity), sin(in*sensitivity))
00038      *
00039      * Input stream 0: floats
00040      * Ouput stream 0: complex
00041      */
00042     class ANALOG_API phase_modulator_fc : virtual public gr_sync_block
00043     {
00044     public:
00045       // gr::analog::phase_modulator_fc::sptr
00046       typedef boost::shared_ptr<phase_modulator_fc> sptr;
00047 
00048       /* \brief Make a phase modulator block.
00049        *
00050        * \param sensitivity Phase change sensitivity of input amplitude.
00051        */
00052       static sptr make(double sensitivity);
00053 
00054       virtual double sensitivity() const = 0;
00055       virtual double phase() const = 0;
00056 
00057       virtual void set_sensitivity(double s) = 0;
00058       virtual void set_phase(double p) = 0;
00059     };
00060   
00061   } /* namespace analog */
00062 } /* namespace gr */
00063 
00064 #endif /* INCLUDED_ANALOG_PHASE_MODULATOR_FC_H */