GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
selector.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2019 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_GR_SELECTOR_H
24#define INCLUDED_GR_SELECTOR_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/blocks/api.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief output[output_index][i] = input[input_index][i]
34 * \ingroup misc_blk
35 *
36 * \details
37 * Connect the sink at input index to the source at output index
38 * Samples from other input ports are consumed and dumped
39 * Other output ports produce no samples
40 *
41 */
42class BLOCKS_API selector : virtual public block
43{
44public:
45 typedef boost::shared_ptr<selector> sptr;
46
47 static sptr
48 make(size_t itemsize, unsigned int input_index, unsigned int output_index);
49
50 // When enabled is set to false, no output samples are produced
51 // Otherwise samples are copied to the selected output port
52 virtual void set_enabled(bool enable) = 0;
53 virtual bool enabled() const = 0;
54
55 virtual void set_input_index(unsigned int input_index) = 0;
56 virtual int input_index() const = 0;
57
58 virtual void set_output_index(unsigned int output_index) = 0;
59 virtual int output_index() const = 0;
60};
61
62} /* namespace blocks */
63} /* namespace gr */
64
65#endif /* INCLUDED_GR_SELECTOR_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
output[output_index][i] = input[input_index][i]
Definition: selector.h:43
virtual int input_index() const =0
virtual void set_output_index(unsigned int output_index)=0
static sptr make(size_t itemsize, unsigned int input_index, unsigned int output_index)
boost::shared_ptr< selector > sptr
Definition: selector.h:45
virtual bool enabled() const =0
virtual void set_input_index(unsigned int input_index)=0
virtual int output_index() const =0
virtual void set_enabled(bool enable)=0
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45