GNU Radio C++ API Reference 3.10.11.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
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 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_MULTIPLY_BY_TAG_VALUE_CC_H
12#define INCLUDED_MULTIPLY_BY_TAG_VALUE_CC_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace blocks {
19
20/*!
21 * \brief output = input * complex constant
22 * \ingroup math_operators_blk
23 *
24 * \details
25 * The complex constant used by this block is found from a tag
26 * with the name specified by \p tag_name. The tag must contain a
27 * float/double or complex PMT value that will be converted into a
28 * gr_complex value. All input data is multiplied by this
29 * value until a new tag with an update value is found. The block
30 * starts with a value of '1.0' for the multiplier constant.
31 */
33{
34public:
35 // gr::blocks::multiply_by_tag_value_cc::sptr
36 typedef std::shared_ptr<multiply_by_tag_value_cc> sptr;
37
38 /*!
39 * \brief Create an instance of multiply_by_tag_value_cc
40 * \param tag_name Tag's key that it will use to get the
41 * multiplicative constant.
42 * \param vlen Vector length of incoming stream
43 */
44 static sptr make(const std::string& tag_name, size_t vlen = 1);
45
46 /*!
47 * Get the current multiplicative constant.
48 * This block does not allow external setters.
49 */
50 virtual gr_complex k() const = 0;
51};
52
53} /* namespace blocks */
54} /* namespace gr */
55
56#endif /* INCLUDED_MULTIPLY_BY_TAG_VALUE_CC_H */
output = input * complex constant
Definition multiply_by_tag_value_cc.h:33
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.
std::shared_ptr< multiply_by_tag_value_cc > sptr
Definition multiply_by_tag_value_cc.h:36
synchronous 1:1 input to output with history
Definition sync_block.h:26
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
std::complex< float > gr_complex
Definition gr_complex.h:15
GNU Radio logging wrapper.
Definition basic_block.h:29