GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
multiply_const_cc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 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_MULTIPLY_CONST_CC_H
24 #define INCLUDED_MULTIPLY_CONST_CC_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 output = input * complex constant
34  * \ingroup math_operators_blk
35  */
36  class BLOCKS_API multiply_const_cc : virtual public sync_block
37  {
38 
39  public:
40 
41  // gr::blocks::multiply_const_cc::sptr
42  typedef boost::shared_ptr<multiply_const_cc> sptr;
43 
44  /*!
45  * \brief Create an instance of multiply_const_cc
46  * \param k complex multiplicative constant
47  * \param vlen Vector length of incoming stream
48  */
49  static sptr make(gr_complex k, size_t vlen=1);
50 
51  /*!
52  * \brief Return complex multiplicative constant
53  */
54  virtual gr_complex k() const = 0;
55 
56  /*!
57  * \brief Set complex multiplicative constant
58  */
59  virtual void set_k(gr_complex k) = 0;
60  };
61 
62  } /* namespace blocks */
63 } /* namespace gr */
64 
65 #endif /* INCLUDED_MULTIPLY_CONST_CC_H */
std::complex< float > gr_complex
Definition: gr_complex.h:27
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
boost::shared_ptr< multiply_const_cc > sptr
Definition: multiply_const_cc.h:42
output = input * complex constant
Definition: multiply_const_cc.h:36