Merge branch 'wip/dxpsk' of http://gnuradio.org/git/jblum

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

diff --git a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
index ba4e69c888239375cf03ec251e12b6e241088a86..3b4aab86c0d89d06a8bc29df49660787aa940f36 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
+++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
@@ -30,7 +30,7 @@
 
 
 /*! \brief A Costas loop carrier recovery module.
- * \ingroup clock
+ * \ingroup sync_blk
  *  
  *  The Costas loop locks to the center frequency of a signal and
  *  downconverts it to baseband. The second (order=2) order loop is
@@ -49,8 +49,8 @@
  *  
  * \param alpha the loop gain used for phase adjustment
  * \param beta the loop gain for frequency adjustments
- * \param max_freq the maximum frequency deviation (normalized frequency) the loop can handle
- * \param min_freq the minimum frequency deviation (normalized frequency) the loop can handle
+ * \param max_freq the maximum frequency deviation (radians/sample) the loop can handle
+ * \param min_freq the minimum frequency deviation (radians/sample) the loop can handle
  * \param order the loop order, either 2 or 4
  */
 class gr_costas_loop_cc;
@@ -66,7 +66,7 @@ gr_make_costas_loop_cc (float alpha, float beta,
 
 /*!
  * \brief Carrier tracking PLL for QPSK
- * \ingroup clock
+ * \ingroup sync_blk
  * input: complex; output: complex
  * <br>The Costas loop can have two output streams:
  *    stream 1 is the baseband I and Q;
@@ -96,7 +96,7 @@ class gr_costas_loop_cc : public gr_sync_block
   float phase_detector_4(gr_complex sample) const;    // for QPSK
 
   /*! \brief the phase detector circuit for second-order loops
-   *  \param a complex sample
+   *  \param sample a complex sample
    *  \return the phase error
    */
   float phase_detector_2(gr_complex sample) const;    // for BPSK
@@ -129,6 +129,11 @@ public:
   int work (int noutput_items,
            gr_vector_const_void_star &input_items,
            gr_vector_void_star &output_items);
+
+  /*! \brief returns the current NCO frequency in radians/sample
+   *
+   */
+  float freq() const { return d_freq; }
 };
 
 #endif