GNU Radio 3.6.5 C++ API
noise_source_s.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004,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 // WARNING: this file is machine generated. Edits will be overwritten
24 
25 #ifndef INCLUDED_ANALOG_NOISE_SOURCE_S_H
26 #define INCLUDED_ANALOG_NOISE_SOURCE_S_H
27 
28 #include <analog/api.h>
29 #include <analog/noise_type.h>
30 #include <gr_sync_block.h>
31 #include <gr_random.h>
32 
33 namespace gr {
34  namespace analog {
35 
36  /*!
37  * \brief Random number source
38  * \ingroup waveform_generators_blk
39  *
40  * \details
41  * Generate random values from different distributions.
42  * Currently, only Gaussian and uniform are enabled.
43  */
44  class ANALOG_API noise_source_s : virtual public gr_sync_block
45  {
46  public:
47  // gr::analog::noise_source_s::sptr
48  typedef boost::shared_ptr<noise_source_s> sptr;
49 
50  /*! Build a noise source
51  * \param type the random distribution to use (see analog/noise_type.h)
52  * \param ampl a scaling factor for the output
53  * \param seed seed for random generators. Note that for uniform and
54  * Gaussian distributions, this should be a negative number.
55  */
56  static sptr make(noise_type_t type, float ampl, long seed);
57 
58  virtual void set_type(noise_type_t type) = 0;
59  virtual void set_amplitude(float ampl) = 0;
60 
61  virtual noise_type_t type() const = 0;
62  virtual float amplitude() const = 0;
63  };
64 
65  } /* namespace analog */
66 } /* namespace gr */
67 
68 #endif /* INCLUDED_ANALOG_NOISE_SOURCE_S_H */