GNU Radio 3.5.1 C++ API
gr_nop.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2010 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_NOP_H
00024 #define INCLUDED_GR_NOP_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_block.h>
00028 #include <stddef.h>                     // size_t
00029 
00030 class gr_nop;
00031 typedef boost::shared_ptr<gr_nop> gr_nop_sptr;
00032 
00033 GR_CORE_API gr_nop_sptr
00034 gr_make_nop (size_t sizeof_stream_item);
00035 
00036 /*!
00037  * \brief Does nothing.  Used for testing only.
00038  * \ingroup misc_blk
00039  */
00040 class GR_CORE_API gr_nop : public gr_block
00041 {
00042   friend GR_CORE_API gr_nop_sptr gr_make_nop (size_t sizeof_stream_item);
00043   gr_nop (size_t sizeof_stream_item);
00044 
00045 protected:
00046   int   d_nmsgs_recvd;
00047 
00048   // Method that just counts any received messages.
00049   void count_received_msgs(pmt::pmt_t msg);
00050 
00051  public:
00052   virtual int general_work (int noutput_items,
00053                             gr_vector_int &ninput_items,
00054                             gr_vector_const_void_star &input_items,
00055                             gr_vector_void_star &output_items);
00056 
00057   int nmsgs_received() const { return d_nmsgs_recvd; }
00058 
00059 };
00060 
00061 #endif /* INCLUDED_GR_NOP_H */