GNU Radio 3.7.2 C++ API
multiply_const_ff.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 // @WARNING@
24 
25 #ifndef INCLUDED_MULTIPLY_CONST_FF_H
26 #define INCLUDED_MULTIPLY_CONST_FF_H
27 
28 #include <gnuradio/blocks/api.h>
29 #include <gnuradio/sync_block.h>
30 
31 namespace gr {
32  namespace blocks {
33 
34  /*!
35  * \brief output = input * real constant
36  * \ingroup math_operators_blk
37  */
38  class BLOCKS_API multiply_const_ff : virtual public sync_block
39  {
40 
41  public:
42 
43  // gr::blocks::multiply_const_ff::sptr
45 
46  /*!
47  * \brief Create an instance of multiply_const_ff
48  * \param k real multiplicative constant
49  * \param vlen Vector length of incoming stream
50  */
51  static sptr make(float k, size_t vlen=1);
52 
53  /*!
54  * \brief Return real multiplicative constant
55  */
56  virtual float k() const = 0;
57 
58  /*!
59  * \brief Set real multiplicative constant
60  */
61  virtual void set_k(float k) = 0;
62  };
63 
64  } /* namespace blocks */
65 } /* namespace gr */
66 
67 #endif /* INCLUDED_MULTIPLY_CONST_FF_H */
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
boost::shared_ptr< multiply_const_ff > sptr
Definition: multiply_const_ff.h:44
output = input * real constant
Definition: multiply_const_ff.h:38
#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