GNU Radio 3.4.0 C++ API
gr_copy.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,2009 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_COPY_H
00024 #define INCLUDED_GR_COPY_H
00025 
00026 #include <gr_block.h>
00027 
00028 class gr_copy;
00029 typedef boost::shared_ptr<gr_copy> gr_copy_sptr;
00030 
00031 gr_copy_sptr gr_make_copy(size_t itemsize);
00032 
00033 /*!
00034  * \brief output[i] = input[i]
00035  * \ingroup misc_blk
00036  *
00037  * When enabled (default), this block copies its input to its output.
00038  * When disabled, this block drops its input on the floor.
00039  *
00040  */
00041 class gr_copy : public gr_block
00042 {
00043   size_t                d_itemsize;
00044   bool                  d_enabled;
00045 
00046   friend gr_copy_sptr gr_make_copy(size_t itemsize);
00047   gr_copy(size_t itemsize);
00048 
00049  public:
00050 
00051   bool check_topology(int ninputs, int noutputs);
00052 
00053   void set_enabled(bool enable) { d_enabled = enable; }
00054   bool enabled() const { return d_enabled;}
00055 
00056   int general_work(int noutput_items,
00057                    gr_vector_int &ninput_items,
00058                    gr_vector_const_void_star &input_items,
00059                    gr_vector_void_star &output_items);
00060 };
00061 
00062 #endif