GNU Radio 3.7.1 C++ API
copy.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,2009,2013 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 <gnuradio/blocks/api.h>
00027 #include <gnuradio/block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief output[i] = input[i]
00034      * \ingroup misc_blk
00035      *
00036      * \details
00037      * When enabled (default), this block copies its input to its
00038      * output. When disabled, this block drops its input on the floor.
00039      */
00040     class BLOCKS_API copy : virtual public block
00041     {
00042     public:
00043       // gr::blocks::copy::sptr
00044       typedef boost::shared_ptr<copy> sptr;
00045 
00046       static sptr make(size_t itemsize);
00047 
00048       virtual void set_enabled(bool enable) = 0;
00049       virtual bool enabled() const = 0;
00050     };
00051 
00052   } /* namespace blocks */
00053 } /* namespace gr */
00054 
00055 #endif /* INCLUDED_GR_COPY_H */