git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_skiphead.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2005 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 2, 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_SKIPHEAD_H
  24 #define INCLUDED_GR_SKIPHEAD_H
  25
  26 #include <gr_sync_block.h>
  27 #include <stddef.h>      // size_t
  28
  29 /*!
  30  * \brief skips the first N items, from then on copies items to the output
  31  * \ingroup block
  32  *
  33  * Useful for building test cases and sources which have metadata or junk at the start
  34  */
  35
  36 class gr_skiphead : public gr_sync_block
  37 {
  38   friend gr_block_sptr gr_make_skiphead (size_t sizeof_stream_item, int nitems);
  39   gr_skiphead (size_t sizeof_stream_item, int nitems);
  40
  41   int  d_nitems;
  42   int  d_nskipped_items;
  43
  44  public:
  45   int work (int noutput_items,
  46      gr_vector_const_void_star &input_items,
  47      gr_vector_void_star &output_items);
  48 };
  49
  50 gr_block_sptr
  51 gr_make_skiphead (size_t sizeof_stream_item, int nitems);
  52
  53
  54 #endif /* INCLUDED_GR_SKIPHEAD_H */