GNU Radio 3.4.0 C++ API
gr_head.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,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_HEAD_H
00024 #define INCLUDED_GR_HEAD_H
00025 
00026 #include <gr_sync_block.h>
00027 #include <stddef.h>                     // size_t
00028 
00029 class gr_head;
00030 typedef boost::shared_ptr<gr_head> gr_head_sptr;
00031 
00032 /*!
00033  * \brief copies the first N items to the output then signals done
00034  * \ingroup slicedice_blk
00035  *
00036  * Useful for building test cases
00037  */
00038 
00039 class gr_head : public gr_sync_block
00040 {
00041   friend gr_head_sptr gr_make_head (size_t sizeof_stream_item, unsigned long long nitems);
00042   gr_head (size_t sizeof_stream_item, unsigned long long nitems);
00043 
00044   unsigned long long    d_nitems;
00045   unsigned long long    d_ncopied_items;
00046 
00047  public:
00048   int work (int noutput_items,
00049                  gr_vector_const_void_star &input_items,
00050                  gr_vector_void_star &output_items);
00051 
00052   void reset() { d_ncopied_items = 0; }
00053 };
00054 
00055 gr_head_sptr
00056 gr_make_head (size_t sizeof_stream_item, unsigned long long nitems);
00057 
00058 
00059 #endif /* INCLUDED_GR_HEAD_H */