GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
head.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,2009,2012,2013 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 <gnuradio/blocks/api.h>
27 #include <gnuradio/sync_block.h>
28 #include <stddef.h> // size_t
29 
30 namespace gr {
31  namespace blocks {
32 
33  /*!
34  * \brief copies the first N items to the output then signals done
35  * \ingroup misc_blk
36  *
37  * \details
38  * Useful for building test cases
39  */
40  class BLOCKS_API head : virtual public sync_block
41  {
42  public:
43  // gr::blocks::head::sptr
44  typedef boost::shared_ptr<head> sptr;
45 
46  static sptr make(size_t sizeof_stream_item,
47  uint64_t nitems);
48 
49  virtual void reset() = 0;
50  virtual void set_length(uint64_t nitems) = 0;
51  };
52 
53  } /* namespace blocks */
54 } /* namespace gr */
55 
56 #endif /* INCLUDED_GR_HEAD_H */
sync_block.h
gr
Include this header to use the message passing features.
Definition: logger.h:695
gr::blocks::head
copies the first N items to the output then signals done
Definition: head.h:40
BLOCKS_API
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
gr::sync_block
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
gr::blocks::head::sptr
boost::shared_ptr< head > sptr
Definition: head.h:44