GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
copy.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,2009,2013 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_COPY_H
24 #define INCLUDED_GR_COPY_H
25 
26 #include <gnuradio/blocks/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief output[i] = input[i]
34  * \ingroup misc_blk
35  *
36  * \details
37  * When enabled (default), this block copies its input to its
38  * output. When disabled, this block drops its input on the floor.
39  *
40  * Message Ports:
41  *
42  * - en (input):
43  * Receives a PMT bool message to either enable to disable
44  * copy.
45  */
46  class BLOCKS_API copy : virtual public block
47  {
48  public:
49  // gr::blocks::copy::sptr
50  typedef boost::shared_ptr<copy> sptr;
51 
52  static sptr make(size_t itemsize);
53 
54  virtual void set_enabled(bool enable) = 0;
55  virtual bool enabled() const = 0;
56  };
57 
58  } /* namespace blocks */
59 } /* namespace gr */
60 
61 #endif /* INCLUDED_GR_COPY_H */
boost::shared_ptr< copy > sptr
Definition: copy.h:50
output[i] = input[i]
Definition: copy.h:46
Include this header to use the message passing features.
Definition: logger.h:695
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing flow is constructed ...
Definition: block.h:65
BLOCKS_API size_t itemsize(vector_type type)