GNU Radio - /gr-digital/lib/digital_constellation_receiver_cb.h - Diff - gnuradio.org

Revision 35fd5072 gr-digital/lib/digital_constellation_receiver_cb.h

 #include <gr_block.h>
 #include <digital_constellation.h>
 #include <gri_control_loop.h>
 #include <gr_complex.h>
 #include <math.h>
 #include <fstream>
-...
+ *
  */
 class digital_constellation_receiver_cb : public gr_block
 class digital_constellation_receiver_cb : public gr_block, public gri_control_loop
+{
  public:
   int general_work (int noutput_items,
-...
 		    gr_vector_const_void_star &input_items,
 		    gr_vector_void_star &output_items);
   /*******************************************************************
     SET FUNCTIONS
   *******************************************************************/
   /*!
    * \brief Set the loop bandwidth
+   *
    * Set the loop filter's bandwidth to \p bw. This should be between
    * 2*pi/200 and 2*pi/100  (in rads/samp). It must also be a positive
    * number.
+   *
    * When a new damping factor is set, the gains, alpha and beta, of the loop
    * are recalculated by a call to update_gains().
+   *
    * \param bw    (float) new bandwidth
+   *
    */
   void set_loop_bandwidth(float bw);
   /*!
    * \brief Set the loop damping factor
+   *
    * Set the loop filter's damping factor to \p df. The damping factor
    * should be sqrt(2)/2.0 for critically damped systems.
    * Set it to anything else only if you know what you are doing. It must
    * be a number between 0 and 1.
+   *
    * When a new damping factor is set, the gains, alpha and beta, of the loop
    * are recalculated by a call to update_gains().
+   *
    * \param df    (float) new damping factor
+   *
    */
   void set_damping_factor(float df);
   /*!
    * \brief Set the loop gain alpha
+   *
    * Set's the loop filter's alpha gain parameter.
+   *
    * This value should really only be set by adjusting the loop bandwidth
    * and damping factor.
+   *
    * \param alpha    (float) new alpha gain
+   *
    */
   void set_alpha(float alpha);
   /*!
    * \brief Set the loop gain beta
+   *
    * Set's the loop filter's beta gain parameter.
+   *
    * This value should really only be set by adjusting the loop bandwidth
    * and damping factor.
+   *
    * \param beta    (float) new beta gain
+   *
    */
   void set_beta(float beta);
   /*!
    * \brief Set the phase/freq recovery loop's frequency.
+   *
    * Set's the phase/freq recovery loop's frequency. While this is normally
    * updated by the inner loop of the algorithm, it could be useful to
    * manually initialize, set, or reset this under certain circumstances.
+   *
    * \param freq    (float) new frequency
+   *
    */
   void set_frequency(float freq);
   /*!
    * \brief Set the phase/freq recovery loop's phase.
+   *
    * Set's the phase/freq recovery loop's phase. While this is normally
    * updated by the inner loop of the algorithm, it could be useful to
    * manually initialize, set, or reset this under certain circumstances.
+   *
    * \param phase    (float) new phase
+   *
    */
   void set_phase(float phase);
   /*******************************************************************
     GET FUNCTIONS
   *******************************************************************/
   /*!
    * \brief Returns the loop bandwidth
    */
   float get_loop_bandwidth() const;
   /*!
    * \brief Returns the loop damping factor
    */
   float get_damping_factor() const;
   /*!
    * \brief Returns the loop gain alpha
    */
   float get_alpha() const;
   /*!
    * \brief Returns the loop gain beta
    */
   float get_beta() const;
   /*!
    * \brief Get the phase/freq recovery loop's frequency estimate
    */
   float get_frequency() const;
   /*!
    * \brief Get the phase/freq loop's phase estimate
    */
   float get_phase() const;
 protected:
  /*!
-...
   private:
   unsigned int d_M;
   // Members related to carrier and phase tracking
   float d_freq, d_max_freq, d_min_freq;
   float d_phase;
   float d_loop_bw;
   float d_damping;
   float d_alpha;
   float d_beta;
   digital_constellation_sptr d_constellation;
   unsigned int d_current_const_point;

Also available in: Unified diff