gusimplewhiteboard
fsk_frequencies Struct Reference

FSK frequency pair and keying values This struct contains the main components of the FSK analysis. More...

#include <wb_fft_frequencies.h>

Collaboration diagram for fsk_frequencies:

Public Member Functions

 fsk_frequencies (uint16_t hi=320, uint16_t lo=200, uint16_t fsk=0)
 constructor with default hi and low frequencies (C++ only) More...
 
uint16_t hi_freq () const
 getter for the high frequency (C++ only) More...
 
uint16_t lo_freq () const
 getter for the low frequency (C++ only) More...
 
uint16_t hi_percentage () const
 getter for the high frequency FSK percentage (C++ only) More...
 
float hi_ratio () const
 convenience getter for the high to low FSK ratio (C++ only) More...
 
void set_hi_freq (uint16_t hi=320)
 setter for the high frequency FSK percentage (C++ only) More...
 
void set_lo_freq (uint16_t lo=200)
 setter for the low frequency FSK percentage (C++ only) More...
 
void set_hi_percentage (uint16_t percent=0)
 setter for the high frequency FSK percentage (C++ only) More...
 
void set_hi_ratio (float r)
 convenience setter for the high to low FSK ratio (C++ only) More...
 

Public Attributes

unsigned _hi_freq: 12
 high frequency (0..8191 Hz) divided by 2 More...
 
unsigned _lo_freq: 12
 low frequency (0..8191 Hz) divided by 2 More...
 
unsigned _hi_percentage: 7
 FSK hi percentage (0..100 %) More...
 
unsigned _unused_pad: 1
 reserved for future use More...
 

Detailed Description

FSK frequency pair and keying values This struct contains the main components of the FSK analysis.

The results of the analysis contain the two strongest frequencies measured and their relative percentage (the percentage the high requency was present versus the low frequency).

Definition at line 125 of file wb_fft_frequencies.h.

Constructor & Destructor Documentation

◆ fsk_frequencies()

fsk_frequencies::fsk_frequencies ( uint16_t  hi = 320,
uint16_t  lo = 200,
uint16_t  fsk = 0 
)
inline

constructor with default hi and low frequencies (C++ only)

Definition at line 134 of file wb_fft_frequencies.h.

Member Function Documentation

◆ hi_freq()

uint16_t fsk_frequencies::hi_freq ( ) const
inline

getter for the high frequency (C++ only)

Definition at line 137 of file wb_fft_frequencies.h.

References _hi_freq.

◆ hi_percentage()

uint16_t fsk_frequencies::hi_percentage ( ) const
inline

getter for the high frequency FSK percentage (C++ only)

Definition at line 143 of file wb_fft_frequencies.h.

References _hi_percentage.

◆ hi_ratio()

float fsk_frequencies::hi_ratio ( ) const
inline

convenience getter for the high to low FSK ratio (C++ only)

Definition at line 146 of file wb_fft_frequencies.h.

References _hi_percentage.

◆ lo_freq()

uint16_t fsk_frequencies::lo_freq ( ) const
inline

getter for the low frequency (C++ only)

Definition at line 140 of file wb_fft_frequencies.h.

References _lo_freq.

◆ set_hi_freq()

void fsk_frequencies::set_hi_freq ( uint16_t  hi = 320)
inline

setter for the high frequency FSK percentage (C++ only)

Definition at line 149 of file wb_fft_frequencies.h.

References _hi_freq.

◆ set_hi_percentage()

void fsk_frequencies::set_hi_percentage ( uint16_t  percent = 0)
inline

setter for the high frequency FSK percentage (C++ only)

Definition at line 155 of file wb_fft_frequencies.h.

References _hi_percentage.

◆ set_hi_ratio()

void fsk_frequencies::set_hi_ratio ( float  r)
inline

convenience setter for the high to low FSK ratio (C++ only)

Definition at line 158 of file wb_fft_frequencies.h.

References _hi_percentage.

◆ set_lo_freq()

void fsk_frequencies::set_lo_freq ( uint16_t  lo = 200)
inline

setter for the low frequency FSK percentage (C++ only)

Definition at line 152 of file wb_fft_frequencies.h.

References _lo_freq.

Member Data Documentation

◆ _hi_freq

unsigned fsk_frequencies::_hi_freq

high frequency (0..8191 Hz) divided by 2

Definition at line 127 of file wb_fft_frequencies.h.

Referenced by hi_freq(), and set_hi_freq().

◆ _hi_percentage

unsigned fsk_frequencies::_hi_percentage

FSK hi percentage (0..100 %)

Definition at line 129 of file wb_fft_frequencies.h.

Referenced by hi_percentage(), hi_ratio(), set_hi_percentage(), and set_hi_ratio().

◆ _lo_freq

unsigned fsk_frequencies::_lo_freq

low frequency (0..8191 Hz) divided by 2

Definition at line 128 of file wb_fft_frequencies.h.

Referenced by lo_freq(), and set_lo_freq().

◆ _unused_pad

unsigned fsk_frequencies::_unused_pad

reserved for future use

Definition at line 130 of file wb_fft_frequencies.h.


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