Merged r8195:8205 from jcorgan/ecc into trunk. Adds convolutional encoder

[debian/gnuradio] / gnuradio-core / src / lib / general / gr_regenerate_bb.h

diff --git a/gnuradio-core/src/lib/general/gr_regenerate_bb.h b/gnuradio-core/src/lib/general/gr_regenerate_bb.h
index 446e658ae4b527ce91297c57721678e90ab15436..751bc5157401ef49d5e515150bd26256e475df73 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_regenerate_bb.h
+++ b/gnuradio-core/src/lib/general/gr_regenerate_bb.h
@@ -6,7 +6,7 @@
  * 
  * 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 2, or (at your option)
+ * 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,
@@ -31,14 +31,23 @@ typedef boost::shared_ptr<gr_regenerate_bb> gr_regenerate_bb_sptr;
 gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen=500);
 
 /*!
- * \brief Detect the peak of a signal
- * \ingroup block
+ * \brief Detect the peak of a signal and repeat every period samples
+ * \ingroup level
  *
  * If a peak is detected, this block outputs a 1 repeated every period samples 
- * until reset by detection of another 1 on the input
+ * until reset by detection of another 1 on the input or stopped after max_regen
+ * regenerations have occurred.
+ *
+ * Note that if max_regen=(-1)/ULONG_MAX then the regeneration will run forever.
  */
 class gr_regenerate_bb : public gr_sync_block
 {
+  /*!
+   * \brief Make a regenerate block
+   * \param period The number of samples between regenerations
+   * \param max_regen The maximum number of regenerations to perform; if set to 
+   * ULONG_MAX, it will regenerate continuously.
+   */
   friend gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen);
 
   gr_regenerate_bb (int period, unsigned int max_regen);
@@ -50,6 +59,13 @@ class gr_regenerate_bb : public gr_sync_block
   unsigned int d_regen_count;
 
  public:
+  /*! \brief Reset the maximum regeneration count; this will reset the current regen.
+   */
+  void set_max_regen(unsigned int regen);
+
+  /*! \brief Reset the period of regenerations; this will reset the current regen.
+   */
+  void set_period(int period);
 
   int work (int noutput_items,
            gr_vector_const_void_star &input_items,