GNU Radio 3.6.5.1 C++ API
gr_head.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2009,2012 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 3, 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_HEAD_H
24 #define INCLUDED_GR_HEAD_H
25 
26 #include <gr_core_api.h>
27 #include <gr_sync_block.h>
28 #include <stddef.h> // size_t
29 
30 class gr_head;
32 
33 /*!
34  * \brief copies the first N items to the output then signals done
35  *
36  * Useful for building test cases
37  */
38 
40 {
41  friend GR_CORE_API gr_head_sptr gr_make_head (size_t sizeof_stream_item, unsigned long long nitems);
42  gr_head (size_t sizeof_stream_item, unsigned long long nitems);
43 
44  unsigned long long d_nitems;
45  unsigned long long d_ncopied_items;
46 
47  public:
48  int work (int noutput_items,
49  gr_vector_const_void_star &input_items,
50  gr_vector_void_star &output_items);
51 
52  void reset() { d_ncopied_items = 0; }
53  void set_length(int nitems) { d_nitems = nitems; }
54 };
55 
57 gr_make_head (size_t sizeof_stream_item, unsigned long long nitems);
58 
59 
60 #endif /* INCLUDED_GR_HEAD_H */