GNU Radio 3.6.5 C++ API

gr_regenerate_bb.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_REGENERATE_BB_H
00024 #define INCLUDED_GR_REGENERATE_BB_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 
00029 class gr_regenerate_bb;
00030 typedef boost::shared_ptr<gr_regenerate_bb> gr_regenerate_bb_sptr;
00031 
00032 GR_CORE_API gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen=500);
00033 
00034 /*!
00035  * \brief Detect the peak of a signal and repeat every period samples
00036  *
00037  * If a peak is detected, this block outputs a 1 repeated every period samples
00038  * until reset by detection of another 1 on the input or stopped after max_regen
00039  * regenerations have occurred.
00040  *
00041  * Note that if max_regen=(-1)/ULONG_MAX then the regeneration will run forever.
00042  */
00043 class GR_CORE_API gr_regenerate_bb : public gr_sync_block
00044 {
00045   /*!
00046    * \brief Make a regenerate block
00047    * \param period The number of samples between regenerations
00048    * \param max_regen The maximum number of regenerations to perform; if set to
00049    * ULONG_MAX, it will regenerate continuously.
00050    */
00051   friend GR_CORE_API gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen);
00052 
00053   gr_regenerate_bb (int period, unsigned int max_regen);
00054 
00055  private:
00056   int d_period;
00057   int d_countdown;
00058   unsigned int d_max_regen;
00059   unsigned int d_regen_count;
00060 
00061  public:
00062   /*! \brief Reset the maximum regeneration count; this will reset the current regen.
00063    */
00064   void set_max_regen(unsigned int regen);
00065 
00066   /*! \brief Reset the period of regenerations; this will reset the current regen.
00067    */
00068   void set_period(int period);
00069 
00070   int work (int noutput_items,
00071             gr_vector_const_void_star &input_items,
00072             gr_vector_void_star &output_items);
00073 };
00074 
00075 #endif