GNU Radio 3.7.2 C++ API
phase_modulator_fc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2005,2006,2012 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_ANALOG_PHASE_MODULATOR_FC_H
24 #define INCLUDED_ANALOG_PHASE_MODULATOR_FC_H
25 
26 #include <gnuradio/analog/api.h>
27 #include <gnuradio/sync_block.h>
28 
29 namespace gr {
30  namespace analog {
31 
32  /*!
33  * \brief Phase modulator block
34  * \ingroup modulators_blk
35  *
36  * \details
37  * output = complex(cos(in*sensitivity), sin(in*sensitivity))
38  *
39  * Input stream 0: floats
40  * Ouput stream 0: complex
41  */
42  class ANALOG_API phase_modulator_fc : virtual public sync_block
43  {
44  public:
45  // gr::analog::phase_modulator_fc::sptr
47 
48  /* \brief Make a phase modulator block.
49  *
50  * \param sensitivity Phase change sensitivity of input amplitude.
51  */
52  static sptr make(double sensitivity);
53 
54  virtual double sensitivity() const = 0;
55  virtual double phase() const = 0;
56 
57  virtual void set_sensitivity(double s) = 0;
58  virtual void set_phase(double p) = 0;
59  };
60 
61  } /* namespace analog */
62 } /* namespace gr */
63 
64 #endif /* INCLUDED_ANALOG_PHASE_MODULATOR_FC_H */
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
boost::shared_ptr< phase_modulator_fc > sptr
Definition: phase_modulator_fc.h:46
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
Phase modulator block.
Definition: phase_modulator_fc.h:42
#define ANALOG_API
Definition: gr-analog/include/gnuradio/analog/api.h:30