GNU Radio 3.6.1 C++ API
gr_noise_source_f.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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 // WARNING: this file is machine generated. Edits will be over written
24 
25 #ifndef INCLUDED_GR_NOISE_SOURCE_F_H
26 #define INCLUDED_GR_NOISE_SOURCE_F_H
27 
28 #include <gr_core_api.h>
29 #include <gr_sync_block.h>
30 #include <gr_noise_type.h>
31 #include <gr_random.h>
32 
33 
34 class gr_noise_source_f;
36 
37 /*! \brief Make a noise source
38  * \param type the random distribution to use (see gr_noise_type.h)
39  * \param ampl a scaling factor for the output
40  * \param seed seed for random generators. Note that for uniform and
41  * Gaussian distributions, this should be a negative number.
42  */
44 gr_make_noise_source_f (gr_noise_type_t type, float ampl, long seed = 0);
45 
46 /*!
47  * \brief Random number source
48  * \ingroup source_blk
49  *
50  * \details
51  * Generate random values from different distributions.
52  * Currently, only Gaussian and uniform are enabled.
53  *
54  * \param type the random distribution to use (see gr_noise_type.h)
55  * \param ampl a scaling factor for the output
56  * \param seed seed for random generators. Note that for uniform and
57  * Gaussian distributions, this should be a negative number.
58  */
61 
62  gr_make_noise_source_f (gr_noise_type_t type, float ampl, long seed);
63 
64  gr_noise_type_t d_type;
65  float d_ampl;
66  gr_random d_rng;
67 
68  gr_noise_source_f (gr_noise_type_t type, float ampl, long seed = 0);
69 
70  public:
71  void set_type (gr_noise_type_t type) { d_type = type; }
72  void set_amplitude (float ampl) { d_ampl = ampl; }
73 
74  gr_noise_type_t type () const { return d_type; }
75  float amplitude () const { return d_ampl; }
76 
77  virtual int work (int noutput_items,
78  gr_vector_const_void_star &input_items,
79  gr_vector_void_star &output_items);
80 };
81 
82 
83 #endif