diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-02-06 10:53:13 -0500 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-02-06 10:53:13 -0500 |
| commit | 1b4bc1ae038847e738569ca5b2e7aecf6ad90265 (patch) | |
| tree | 2e14459f86625a9e5697c8760691c9c5af4cee45 /gr-analog/include/analog/fastnoise_source_X.h.t | |
| parent | 43c5b002c181d3d270d0cf91591c086d896086aa (diff) | |
analog: adding public header and QA code for fastnoise_source.
Diffstat (limited to 'gr-analog/include/analog/fastnoise_source_X.h.t')
| -rw-r--r-- | gr-analog/include/analog/fastnoise_source_X.h.t | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/gr-analog/include/analog/fastnoise_source_X.h.t b/gr-analog/include/analog/fastnoise_source_X.h.t new file mode 100644 index 0000000000..e1c606692c --- /dev/null +++ b/gr-analog/include/analog/fastnoise_source_X.h.t @@ -0,0 +1,70 @@ +/* -*- c++ -*- */ +/* + * Copyright 2013 Free Software Foundation, Inc. + * + * This file is part of GNU Radio + * + * GNU Radio is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3, or (at your option) + * any later version. + * + * GNU Radio is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GNU Radio; see the file COPYING. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ + +// @WARNING@ + +#ifndef @GUARD_NAME@ +#define @GUARD_NAME@ + +#include <analog/api.h> +#include <analog/noise_type.h> +#include <gr_sync_block.h> + +namespace gr { + namespace analog { + + /*! + * \brief Random number source + * \ingroup source_blk + * + * \details + * Generate random values from different distributions. + * Currently, only Gaussian and uniform are enabled. + */ + class ANALOG_API @BASE_NAME@ : virtual public gr_sync_block + { + public: + // gr::analog::@BASE_NAME@::sptr + typedef boost::shared_ptr<@BASE_NAME@> sptr; + + /*! \brief Make a fast noise source + * \param type the random distribution to use (see analog/noise_type.h) + * \param ampl a scaling factor for the output + * \param seed seed for random generators. Note that for uniform and + * \param samples Number of samples to pre-generate + * Gaussian distributions, this should be a negative number. + */ + static sptr make(noise_type_t type, float ampl, + long seed = 0, long samples=1024*16); + + virtual void set_type(noise_type_t type) = 0; + virtual void set_amplitude(float ampl) = 0; + + virtual noise_type_t type() const = 0; + virtual float amplitude() const = 0; + }; + + } /* namespace analog */ +} /* namespace gr */ + + +#endif /* @GUARD_NAME@ */ |