GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
multiply_by_tag_value_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2016 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * This 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 * This software 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 this software; 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_BY_TAG_VALUE_CC_H
24#define INCLUDED_MULTIPLY_BY_TAG_VALUE_CC_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief output = input * complex constant
34 * \ingroup math_operators_blk
35 *
36 * \details
37 * The complex constant used by this block is found from a tag
38 * with the name specified by \p tag_name. The tag must contain a
39 * float/double or complex PMT value that will be converted into a
40 * gr_complex value. All input data is multiplied by this
41 * value until a new tag with an update value is found. The block
42 * starts with a value of '1.0' for the multiplier constant.
43 */
45{
46public:
47 // gr::blocks::multiply_by_tag_value_cc::sptr
48 typedef boost::shared_ptr<multiply_by_tag_value_cc> sptr;
49
50 /*!
51 * \brief Create an instance of multiply_by_tag_value_cc
52 * \param tag_name Tag's key that it will use to get the
53 * multiplicative constant.
54 * \param vlen Vector length of incoming stream
55 */
56 static sptr make(const std::string& tag_name, size_t vlen = 1);
57
58 /*!
59 * Get the current multiplicative constant.
60 * This block does not allow external setters.
61 */
62 virtual gr_complex k() const = 0;
63};
64
65} /* namespace blocks */
66} /* namespace gr */
67
68#endif /* INCLUDED_MULTIPLY_BY_TAG_VALUE_CC_H */
output = input * complex constant
Definition: multiply_by_tag_value_cc.h:45
virtual gr_complex k() const =0
static sptr make(const std::string &tag_name, size_t vlen=1)
Create an instance of multiply_by_tag_value_cc.
boost::shared_ptr< multiply_by_tag_value_cc > sptr
Definition: multiply_by_tag_value_cc.h:48
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
std::complex< float > gr_complex
Definition: gr_complex.h:27
Include this header to use the message passing features.
Definition: basic_block.h:45