blob: d8a34bf502ed5f9b9e35fa5b11333a8966b191a8 (
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
|
/* -*- c++ -*- */
/*
* Copyright 2004,2009,2012,2013 Free Software Foundation, Inc.
* Copyright 2021 Marcus Müller
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_HEAD_H
#define INCLUDED_GR_HEAD_H
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
#include <cstddef> // size_t
namespace gr {
namespace blocks {
/*!
* \brief stop after processing the first N items
* \ingroup misc_blk
*
* \details
* Useful for building test cases, this block consumes only N items from its input, and
* copies them to its output, if that is connected.
*
* You can hence use this block in series with your sample flow if you want a block
* downstream of it to be tested with an exact number of input items; or you can put it in
* parallel to your data path, so that it stops at most one buffer size after the
* specified number of items has been produced upstream.
*/
class BLOCKS_API head : virtual public sync_block
{
public:
// gr::blocks::head::sptr
typedef std::shared_ptr<head> sptr;
static sptr make(size_t sizeof_stream_item, uint64_t nitems);
virtual void reset() = 0;
virtual void set_length(uint64_t nitems) = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_HEAD_H */
|
