GNU Radio 3.6.5 C++ API

regenerate_bb.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2007,2013 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 <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Detect the peak of a signal and repeat every period samples
00034      * \ingroup stream_operators_blk
00035      *
00036      * \details
00037      * If a peak is detected, this block outputs a 1 repeated every
00038      * period samples until reset by detection of another 1 on the
00039      * input or stopped after max_regen regenerations have occurred.
00040      *
00041      * Note that if max_regen=(-1)/ULONG_MAX then the regeneration
00042      * will run forever.
00043      */
00044     class BLOCKS_API regenerate_bb : virtual public gr_sync_block
00045     {
00046     public:
00047       // gr::blocks::regenerate_bb::sptr
00048       typedef boost::shared_ptr<regenerate_bb> sptr;
00049 
00050       /*!
00051        * \brief Make a regenerate block
00052        * \param period The number of samples between regenerations
00053        * \param max_regen The maximum number of regenerations to
00054        * perform; if set to ULONG_MAX, it will regenerate
00055        * continuously.
00056        */
00057       static sptr make(int period, unsigned int max_regen=500);
00058 
00059       /*! \brief Reset the maximum regeneration count; this will reset
00060           the current regen.
00061        */
00062       virtual void set_max_regen(unsigned int regen) = 0;
00063 
00064       /*! \brief Reset the period of regenerations; this will reset
00065           the current regen.
00066       */
00067       virtual void set_period(int period) = 0;
00068 
00069       /*! \brief return the maximum regeneration count.
00070        */
00071       virtual unsigned int max_regen() const = 0;
00072 
00073       /*! \brief return the regeneration period.
00074        */
00075       virtual int period() const = 0;
00076     };
00077 
00078   } /* namespace blocks */
00079 } /* namespace gr */
00080 
00081 #endif /* INCLUDED_GR_REGENERATE_BB_H */