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 3c43785ba0d69b5214e1c9b18549d91cbb1c8ef2..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
@@ -28,10 +28,9 @@
 #include <stdexcept>
 #include <fstream>
 
-class gr_costas_loop_cc;
-typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
 
 /*! \brief A Costas loop carrier recovery module.
+ * \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
@@ -50,10 +49,14 @@ typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
  *  
  * \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;
+typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr;
+
+
 gr_costas_loop_cc_sptr 
 gr_make_costas_loop_cc (float alpha, float beta,
                        float max_freq, float min_freq, 
@@ -63,7 +66,7 @@ gr_make_costas_loop_cc (float alpha, float beta,
 
 /*!
  * \brief Carrier tracking PLL for QPSK
- * \ingroup block
+ * \ingroup sync_blk
  * input: complex; output: complex
  * <br>The Costas loop can have two output streams:
  *    stream 1 is the baseband I and Q;
@@ -92,8 +95,8 @@ class gr_costas_loop_cc : public gr_sync_block
    */
   float phase_detector_4(gr_complex sample) const;    // for QPSK
 
-  /*! \breif the phase detector circuit for second-order loops
-   *  \param a complex sample
+  /*! \brief the phase detector circuit for second-order loops
+   *  \param sample a complex sample
    *  \return the phase error
    */
   float phase_detector_2(gr_complex sample) const;    // for BPSK
@@ -103,9 +106,34 @@ class gr_costas_loop_cc : public gr_sync_block
 
 public:
 
+  /*! \brief set the first order gain
+   *  \param alpha
+   */
+  void set_alpha(float alpha);
+
+  /*! \brief get the first order gain
+   * 
+   */
+  float alpha() const { return d_alpha; }
+  
+  /*! \brief set the second order gain
+   *  \param beta
+   */
+  void set_beta(float beta);
+
+  /*! \brief get the second order gain
+   * 
+   */
+  float beta() const { return d_beta; }
+  
   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