GNU Radio C++ API Reference: glfsr_source_f.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
glfsr_source_f.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2007,2012,2016 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_GLFSR_SOURCE_F_H
12#define INCLUDED_GR_GLFSR_SOURCE_F_H
13
14#include <gnuradio/digital/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace digital {
19
20/*!
21 * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.
22 * \ingroup waveform_generators_blk
23 */
24 class DIGITAL_API glfsr_source_f : virtual public sync_block
25{
26public:
27 // gr::digital::glfsr_source_f::sptr
28 typedef std::shared_ptr<glfsr_source_f> sptr;
29
30 /*!
31 * Make a Galois LFSR pseudo-random source block.
32 *
33 * \param degree Degree of shift register must be in [1, 64]. If mask
34 * is 0, the degree determines a default mask (see
35 * digital_impl_glfsr.cc for the mapping).
36 * \param repeat Set to repeat sequence.
37 * \param mask Allows a user-defined bit mask for indexes of the shift
38 * register to feed back.
39 * \param seed Initial setting for values in shift register.
40 */
41 static sptr
42 make(unsigned int degree, bool repeat = true, uint64_t mask = 0, uint64_t seed = 1);
43
44 virtual uint64_t period() const = 0;
45 virtual uint64_t mask() const = 0;
46};
47
48} /* namespace digital */
49} /* namespace gr */
50
51#endif /* INCLUDED_GR_GLFSR_SOURCE_F_H */
gr::digital::glfsr_source_f
Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0.
Definition glfsr_source_f.h:25
gr::digital::glfsr_source_f::period
virtual uint64_t period() const =0
gr::digital::glfsr_source_f::make
static sptr make(unsigned int degree, bool repeat=true, uint64_t mask=0, uint64_t seed=1)
gr::digital::glfsr_source_f::mask
virtual uint64_t mask() const =0
gr::digital::glfsr_source_f::sptr
std::shared_ptr< glfsr_source_f > sptr
Definition glfsr_source_f.h:28
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
DIGITAL_API
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:18
gr::digital
Definition adaptive_algorithm.h:22
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h