HARDT - The Ham Radio DSP Toolkit
Public Member Functions | Protected Member Functions | List of all members
HGenerator< T > Class Template Reference

#include <hgenerator.h>

Inheritance diagram for HGenerator< T >:
Inheritance graph
[legend]
Collaboration diagram for HGenerator< T >:
Collaboration graph
[legend]

Public Member Functions

int Read (T *dest, size_t blocksize)
 
void Calculate (int frequency, T amplitude, float phase)
 
bool Command (HCommand *command)
 
Current ()
 
Next ()
 
- Public Member Functions inherited from HReader< T >
virtual ~HReader ()=default
 
virtual bool Start ()
 
virtual bool Stop ()
 
HReader< T > * Reader ()
 
- Public Member Functions inherited from HObject
 HObject ()
 

Protected Member Functions

 HGenerator (H_SAMPLE_RATE rate, int frequency, T amplitude, float phase=0)
 
 ~HGenerator ()
 

Detailed Description

template<class T>
class HGenerator< T >

Base class for the signal generators.

If you need to write a special generator, inherit this class.

Constructor & Destructor Documentation

◆ HGenerator()

template<class T >
HGenerator< T >::HGenerator ( H_SAMPLE_RATE  rate,
int  frequency,
amplitude,
float  phase = 0 
)
protected

Construct a new HGenerator

Parameters
rateSample rate of the generator
frequencyGenerator frequency
amplitudeGenerator amplitude (max abs. value)
phaseGenerator phase (in radians)

◆ ~HGenerator()

template<class T >
HGenerator< T >::~HGenerator
protected

Default destructor

Member Function Documentation

◆ Calculate()

template<class T >
void HGenerator< T >::Calculate ( int  frequency,
amplitude,
float  phase 
)

Calculate and fill generator sample lookup table

◆ Command()

template<class T >
bool HGenerator< T >::Command ( HCommand command)
inlinevirtual

Execute and/or pass on a command

Parameters
commandCommand to send or execute

Implements HReader< T >.

Reimplemented in HVfo< T >, and HLocalOscillator< T >.

◆ Current()

template<class T >
T HGenerator< T >::Current ( )
inline

Return current value from the generator

Returns
Current sequential generator value

◆ Next()

template<class T >
T HGenerator< T >::Next ( )
inline

Return current value from the generator and step to the next value

Returns
Next sequential generator value

◆ Read()

template<class T >
int HGenerator< T >::Read ( T *  dest,
size_t  blocksize 
)
virtual

Read samples from the generator

Parameters
destDestination buffer
blocksizeNumber of samples to read

Implements HReader< T >.


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