gr::analog::pll_refout_cc_impl Class Reference

#include <pll_refout_cc_impl.h>

Inheritance diagram for gr::analog::pll_refout_cc_impl:

List of all members.

Public Member Functions
	pll_refout_cc_impl (float loop_bw, float max_freq, float min_freq)
	~pll_refout_cc_impl ()
void	set_loop_bandwidth (float bw)
	Set the loop bandwidth.
void	set_damping_factor (float df)
	Set the loop damping factor.
void	set_alpha (float alpha)
	Set the loop gain alpha.
void	set_beta (float beta)
	Set the loop gain beta.
void	set_frequency (float freq)
	Set the control loop's frequency.
void	set_phase (float phase)
	Set the control loop's phase.
void	set_min_freq (float freq)
	Set the control loop's minimum frequency.
void	set_max_freq (float freq)
	Set the control loop's maximum frequency.
float	get_loop_bandwidth () const
	Returns the loop bandwidth.
float	get_damping_factor () const
	Returns the loop damping factor.
float	get_alpha () const
	Returns the loop gain alpha.
float	get_beta () const
	Returns the loop gain beta.
float	get_frequency () const
	Get the control loop's frequency estimate.
float	get_phase () const
	Get the control loop's phase estimate.
float	get_min_freq () const
	Get the control loop's minimum frequency.
float	get_max_freq () const
	Get the control loop's maximum frequency.
int	work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
	just like gr_block::general_work, only this arranges to call consume_each for you

---

Constructor & Destructor Documentation

gr::analog::pll_refout_cc_impl::pll_refout_cc_impl	(	float	loop_bw,
		float	max_freq,
		float	min_freq
	)

gr::analog::pll_refout_cc_impl::~pll_refout_cc_impl

(

)

---

Member Function Documentation

float gr::analog::pll_refout_cc_impl::get_alpha

(

)

const

Returns the loop gain alpha.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_beta

(

)

const

Returns the loop gain beta.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_damping_factor

(

)

const

Returns the loop damping factor.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_frequency

(

)

const

Get the control loop's frequency estimate.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_loop_bandwidth

(

)

const

Returns the loop bandwidth.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_max_freq

(

)

const

Get the control loop's maximum frequency.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_min_freq

(

)

const

Get the control loop's minimum frequency.

Reimplemented from gri_control_loop.

float gr::analog::pll_refout_cc_impl::get_phase

(

)

const

Get the control loop's phase estimate.

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_alpha

(

float

alpha

)

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.

Parameters:

alpha

(float) new alpha gain

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_beta

(

float

beta

)

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.

Parameters:

beta	(float) new beta gain

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_damping_factor

(

float

df

)

Set the loop damping factor.

Set the loop filter's damping factor to 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().

Parameters:

df	(float) new damping factor

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_frequency

(

float

freq

)

Set the control loop's frequency.

Set's the control 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.

Parameters:

freq	(float) new frequency

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_loop_bandwidth

(

float

bw

)

Set the loop bandwidth.

Set the loop filter's bandwidth to 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().

Parameters:

bw	(float) new bandwidth

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_max_freq

(

float

freq

)

Set the control loop's maximum frequency.

Set the maximum frequency the control loop can track.

Parameters:

freq	(float) new max frequency

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_min_freq

(

float

freq

)

Set the control loop's minimum frequency.

Set the minimum frequency the control loop can track.

Parameters:

freq	(float) new min frequency

Reimplemented from gri_control_loop.

void gr::analog::pll_refout_cc_impl::set_phase

(

float

phase

)

Set the control loop's phase.

Set's the control 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.

Parameters:

phase

(float) new phase

Reimplemented from gri_control_loop.

int gr::analog::pll_refout_cc_impl::work	(	int	noutput_items,
		gr_vector_const_void_star &	input_items,
		gr_vector_void_star &	output_items
	)		[virtual]

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implements gr_sync_block.

---

The documentation for this class was generated from the following file:

• pll_refout_cc_impl.h