summaryrefslogtreecommitdiff
path: root/gnuradio-core/src/lib/general/gr_head.h
blob: 71885cce0c45a7cdeb490f1f8bf416d6f7a0487c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/* -*- c++ -*- */
/*
 * Copyright 2004 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_GR_HEAD_H
#define INCLUDED_GR_HEAD_H

#include <gr_sync_block.h>
#include <stddef.h>			// size_t

/*!
 * \brief copies the first N items to the output then signals done
 * \ingroup block
 *
 * Useful for building test cases
 */

class gr_head : public gr_sync_block
{
  friend gr_block_sptr gr_make_head (size_t sizeof_stream_item, int nitems);
  gr_head (size_t sizeof_stream_item, int nitems);

  int	d_nitems;
  int	d_ncopied_items;

 public:
  int work (int noutput_items,
		 gr_vector_const_void_star &input_items,
		 gr_vector_void_star &output_items);
};

gr_block_sptr
gr_make_head (size_t sizeof_stream_item, int nitems);


#endif /* INCLUDED_GR_HEAD_H */