GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
glfsr_source_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2007,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_GR_GLFSR_SOURCE_F_H
24#define INCLUDED_GR_GLFSR_SOURCE_F_H
25
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace digital {
31
32/*!
33 * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.
34 * \ingroup waveform_generators_blk
35 */
37{
38public:
39 // gr::digital::glfsr_source_f::sptr
40 typedef boost::shared_ptr<glfsr_source_f> sptr;
41
42 /*!
43 * Make a Galois LFSR pseudo-random source block.
44 *
45 * \param degree Degree of shift register must be in [1, 32]. If mask
46 * is 0, the degree determines a default mask (see
47 * digital_impl_glfsr.cc for the mapping).
48 * \param repeat Set to repeat sequence.
49 * \param mask Allows a user-defined bit mask for indexes of the shift
50 * register to feed back.
51 * \param seed Initial setting for values in shift register.
52 */
53 static sptr make(int degree, bool repeat = true, int mask = 0, int seed = 1);
54
55 virtual unsigned int period() const = 0;
56 virtual int mask() const = 0;
57};
58
59} /* namespace digital */
60} /* namespace gr */
61
62#endif /* INCLUDED_GR_GLFSR_SOURCE_F_H */
Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.
Definition: glfsr_source_f.h:37
boost::shared_ptr< glfsr_source_f > sptr
Definition: glfsr_source_f.h:40
virtual int mask() const =0
static sptr make(int degree, bool repeat=true, int mask=0, int seed=1)
virtual unsigned int period() const =0
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45