GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
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
31namespace gr {
32namespace blocks {
33
34/*!
35 * \brief output = input * real constant
36 * \ingroup math_operators_blk
37 */
39{
40
41public:
42 // gr::blocks::multiply_const_ff::sptr
43 typedef boost::shared_ptr<multiply_const_ff> sptr;
44
45 /*!
46 * \brief Create an instance of multiply_const_ff
47 * \param k real multiplicative constant
48 * \param vlen Vector length of incoming stream
49 */
50 static sptr make(float k, size_t vlen = 1);
51
52 /*!
53 * \brief Return real multiplicative constant
54 */
55 virtual float k() const = 0;
56
57 /*!
58 * \brief Set real multiplicative constant
59 */
60 virtual void set_k(float k) = 0;
61};
62
63} /* namespace blocks */
64} /* namespace gr */
65
66#endif /* INCLUDED_MULTIPLY_CONST_FF_H */
output = input * real constant
Definition: multiply_const_ff.h:39
virtual void set_k(float k)=0
Set real multiplicative constant.
virtual float k() const =0
Return real multiplicative constant.
boost::shared_ptr< multiply_const_ff > sptr
Definition: multiply_const_ff.h:43
static sptr make(float k, size_t vlen=1)
Create an instance of multiply_const_ff.
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45