GNU Radio Manual and C++ API Reference  3.9.2.0
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  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_GR_HEAD_H
12 #define INCLUDED_GR_HEAD_H
13 
14 #include <gnuradio/blocks/api.h>
15 #include <gnuradio/sync_block.h>
16 #include <cstddef> // size_t
17 
18 namespace gr {
19 namespace blocks {
20 
21 /*!
22  * \brief copies the first N items to the output then signals done
23  * \ingroup misc_blk
24  *
25  * \details
26  * Useful for building test cases
27  */
28 class BLOCKS_API head : virtual public sync_block
29 {
30 public:
31  // gr::blocks::head::sptr
32  typedef std::shared_ptr<head> sptr;
33 
34  static sptr make(size_t sizeof_stream_item, uint64_t nitems);
35 
36  virtual void reset() = 0;
37  virtual void set_length(uint64_t nitems) = 0;
38 };
39 
40 } /* namespace blocks */
41 } /* namespace gr */
42 
43 #endif /* INCLUDED_GR_HEAD_H */
copies the first N items to the output then signals done
Definition: head.h:29
virtual void set_length(uint64_t nitems)=0
static sptr make(size_t sizeof_stream_item, uint64_t nitems)
virtual void reset()=0
std::shared_ptr< head > sptr
Definition: head.h:32
synchronous 1:1 input to output with history
Definition: sync_block.h:26
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:18
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition: basic_block.h:29