GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
skiphead.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,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_SKIPHEAD_H
24#define INCLUDED_GR_SKIPHEAD_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28#include <stddef.h> // size_t
29
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief skips the first N items, from then on copies items to the output
35 * \ingroup misc_blk
36 *
37 * \details
38 * Useful for building test cases and sources which have metadata
39 * or junk at the start
40 */
41class BLOCKS_API skiphead : virtual public block
42{
43public:
44 // gr::blocks::skiphead::sptr
45 typedef boost::shared_ptr<skiphead> sptr;
46
47 static sptr make(size_t itemsize, uint64_t nitems_to_skip);
48};
49
50} /* namespace blocks */
51} /* namespace gr */
52
53#endif /* INCLUDED_GR_SKIPHEAD_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
skips the first N items, from then on copies items to the output
Definition: skiphead.h:42
boost::shared_ptr< skiphead > sptr
Definition: skiphead.h:45
static sptr make(size_t itemsize, uint64_t nitems_to_skip)
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45