Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

SPUC::loop_filter< Numeric > Class Template Reference
[Phase lock loop functions]

Loop Filter for use in PLL circuits. More...

#include <loop_filter.h>

Collaboration diagram for SPUC::loop_filter< Numeric >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 loop_filter (void)
 Constructor.
void reset (void)
 Reset.
Numeric update (Numeric error)
 Normal call with input, returns output.

Public Attributes

long k0_en
 enable first order branch
long k1_en
 enable second order branch
Numeric k0
 First order gain.
Numeric k1
 second order gain
Numeric k1_acc
 Accumulator for k1 branch (should not be written to).

Protected Attributes

Numeric loop_out
Numeric k1_prod
Numeric k0_prod

Detailed Description

template<class Numeric>
class SPUC::loop_filter< Numeric >

Loop Filter for use in PLL circuits.

: Template for 2nd order loop filter (for timing/carrier recovery, etc). Either branch can be enabled/disabled for 1st/2nd order operation There is no overflow protection on accumulator. Gains are not normalized.

loop_filter.gif


Constructor & Destructor Documentation

template<class Numeric>
SPUC::loop_filter< Numeric >::loop_filter void   )  [inline]
 

Constructor.


Member Function Documentation

template<class Numeric>
void SPUC::loop_filter< Numeric >::reset void   )  [inline]
 

Reset.

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::update Numeric  error  )  [inline]
 

Normal call with input, returns output.


Member Data Documentation

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::k0
 

First order gain.

template<class Numeric>
long SPUC::loop_filter< Numeric >::k0_en
 

enable first order branch

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::k0_prod [protected]
 

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::k1
 

second order gain

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::k1_acc
 

Accumulator for k1 branch (should not be written to).

template<class Numeric>
long SPUC::loop_filter< Numeric >::k1_en
 

enable second order branch

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::k1_prod [protected]
 

template<class Numeric>
Numeric SPUC::loop_filter< Numeric >::loop_out [protected]
 


The documentation for this class was generated from the following file:
Generated on Fri Sep 16 11:09:05 2005 for spuc by  doxygen 1.4.4