GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
keep_m_in_n.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 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_BLOCKS_KEEP_M_IN_N_H
24#define INCLUDED_BLOCKS_KEEP_M_IN_N_H
25
26#include <gnuradio/block.h>
27#include <gnuradio/blocks/api.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief decimate a stream, keeping the first \p m items out of every \p n starting after
34 * \p offset items. \ingroup stream_operators_blk
35 */
36class BLOCKS_API keep_m_in_n : virtual public block
37{
38public:
39 // gr::blocks::keep_m_in_n::sptr
40 typedef boost::shared_ptr<keep_m_in_n> sptr;
41
42 /*!
43 * Make a keep m in n block.
44 *
45 * \param itemsize stream itemsize
46 * \param m number of items to take in block of \p n items
47 * \param n block size in items
48 * \param offset initial item offset into the stream
49 */
50 static sptr make(size_t itemsize, int m, int n, int offset);
51
52 virtual void set_m(int m) = 0;
53 virtual void set_n(int n) = 0;
54 virtual void set_offset(int offset) = 0;
55};
56
57} /* namespace blocks */
58} /* namespace gr */
59
60#endif /* INCLUDED_BLOCKS_KEEP_M_IN_N_H */
The abstract base class for all 'terminal' processing blocks.
Definition: block.h:66
decimate a stream, keeping the first m items out of every n starting after offset items.
Definition: keep_m_in_n.h:37
virtual void set_offset(int offset)=0
virtual void set_m(int m)=0
boost::shared_ptr< keep_m_in_n > sptr
Definition: keep_m_in_n.h:40
virtual void set_n(int n)=0
static sptr make(size_t itemsize, int m, int n, int offset)
#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