GNU Radio 3.6.5 C++ API

gr_glfsr_source_f.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2007 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 #ifndef INCLUDED_GR_GLFSR_SOURCE_F_H
00024 #define INCLUDED_GR_GLFSR_SOURCE_F_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 
00029 class gri_glfsr;
00030 
00031 class gr_glfsr_source_f;
00032 typedef boost::shared_ptr<gr_glfsr_source_f> gr_glfsr_source_f_sptr;
00033 
00034 GR_CORE_API gr_glfsr_source_f_sptr gr_make_glfsr_source_f(int degree, bool repeat=true, int mask=0, int seed=1);
00035 
00036 /*!
00037  * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0
00038  */
00039 class GR_CORE_API gr_glfsr_source_f : public gr_sync_block
00040 {
00041  private:
00042   friend GR_CORE_API gr_glfsr_source_f_sptr
00043   gr_make_glfsr_source_f(int degree, bool repeat, int mask, int seed);
00044 
00045   gri_glfsr *d_glfsr;
00046 
00047   bool d_repeat;
00048   unsigned int d_index;
00049   unsigned int d_length;
00050 
00051   gr_glfsr_source_f(int degree, bool repeat, int mask, int seed);
00052 
00053  public:
00054 
00055   ~gr_glfsr_source_f();
00056 
00057   int work(int noutput_items,
00058            gr_vector_const_void_star &input_items,
00059            gr_vector_void_star &output_items);
00060 
00061   unsigned int period() const { return d_length; }
00062   int mask() const;
00063 };
00064 
00065 #endif /* INCLUDED_GR_GLFSR_SOURCE_F_H */