GNU Radio 3.7.1 C++ API
noise_source_s.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2012 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_ANALOG_NOISE_SOURCE_S_H
00026 #define INCLUDED_ANALOG_NOISE_SOURCE_S_H
00027 
00028 #include <gnuradio/analog/api.h>
00029 #include <gnuradio/analog/noise_type.h>
00030 #include <gnuradio/sync_block.h>
00031 
00032 namespace gr {
00033   namespace analog {
00034     
00035     /*!
00036      * \brief Random number source
00037      * \ingroup waveform_generators_blk
00038      *
00039      * \details
00040      * Generate random values from different distributions.
00041      * Currently, only Gaussian and uniform are enabled.
00042      */
00043     class ANALOG_API noise_source_s : virtual public sync_block 
00044     {
00045     public:
00046       // gr::analog::noise_source_s::sptr
00047       typedef boost::shared_ptr<noise_source_s> sptr;
00048 
00049       /*! Build a noise source
00050        * \param type the random distribution to use (see gnuradio/analog/noise_type.h)
00051        * \param ampl a scaling factor for the output
00052        * \param seed seed for random generators. Note that for uniform and
00053        *             Gaussian distributions, this should be a negative number.
00054        */
00055       static sptr make(noise_type_t type, float ampl, long seed=0);
00056 
00057       virtual void set_type(noise_type_t type) = 0;
00058       virtual void set_amplitude(float ampl) = 0;
00059 
00060       virtual noise_type_t type() const = 0;
00061       virtual float amplitude() const = 0;
00062     };
00063 
00064   } /* namespace analog */
00065 } /* namespace gr */
00066 
00067 #endif /* INCLUDED_ANALOG_NOISE_SOURCE_S_H */