GNU Radio 3.6.5 C++ API

gr_noise_source_s.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 // WARNING: this file is machine generated. Edits will be overwritten
00024 
00025 #ifndef INCLUDED_GR_GR_NOISE_SOURCE_S_H
00026 #define INCLUDED_GR_GR_NOISE_SOURCE_S_H
00027 
00028 #include <gr_core_api.h>
00029 #include <gr_sync_block.h>
00030 #include <gr_noise_type.h>
00031 #include <gr_random.h>
00032 
00033 
00034 class gr_noise_source_s;
00035 typedef boost::shared_ptr<gr_noise_source_s> gr_noise_source_s_sptr;
00036 
00037 /*! \brief Make a noise source
00038  * \param type  the random distribution to use (see gr_noise_type.h)
00039  * \param ampl  a scaling factor for the output
00040  * \param seed seed for random generators. Note that for uniform and
00041  * Gaussian distributions, this should be a negative number.
00042  */
00043 GR_CORE_API gr_noise_source_s_sptr
00044 gr_make_noise_source_s (gr_noise_type_t type, float ampl, long seed = 0);
00045 
00046 /*!
00047  * \brief Random number source
00048  * \ingroup source_blk
00049  *
00050  * \details
00051  * Generate random values from different distributions.
00052  * Currently, only Gaussian and uniform are enabled.
00053  *
00054  * \param type  the random distribution to use (see gr_noise_type.h)
00055  * \param ampl  a scaling factor for the output
00056  * \param seed seed for random generators. Note that for uniform and
00057  * Gaussian distributions, this should be a negative number.
00058  */
00059 class GR_CORE_API gr_noise_source_s : public gr_sync_block {
00060   friend GR_CORE_API gr_noise_source_s_sptr
00061 
00062   gr_make_noise_source_s (gr_noise_type_t type, float ampl, long seed);
00063 
00064   gr_noise_type_t       d_type;
00065   float                 d_ampl;
00066   gr_random             d_rng;
00067 
00068   gr_noise_source_s (gr_noise_type_t type, float ampl, long seed = 0);
00069 
00070  public:
00071   void set_type (gr_noise_type_t type) { d_type = type; }
00072   void set_amplitude (float ampl) { d_ampl = ampl; }
00073 
00074   gr_noise_type_t type () const { return d_type; }
00075   float amplitude () const { return d_ampl; }
00076 
00077   virtual int work (int noutput_items,
00078                          gr_vector_const_void_star &input_items,
00079                          gr_vector_void_star &output_items);
00080 };
00081 
00082 
00083 #endif