0.3.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
NAV::SNRMask Class Reference

Signal to Noise Ratio Mask. More...

Public Member Functions

bool checkSNRMask (Frequency freq, double elevation, double SNR) const
 Checks wether the SNR values passes the SNR mask.
 
void disable ()
 Disables the SNR mask by setting all values to 0.
 
bool isInactive () const
 Checks wether all SNR values are 0.
 
bool ShowGuiWidgets (const char *label=nullptr)
 Shows a button to select the SNR Mask.
 
 SNRMask ()
 Default Constructor.
 

Private Attributes

std::pair< std::array< double, elevations.size()>, bool > allOverride
 Values when changed override all others.
 
std::array< std::pair< Frequency, std::pair< std::array< double, elevations.size()>, bool > >, Frequency::GetAll().size()> mask
 Masks for all frequencies and SNR [dbHz] values + lock together boolean.
 

Static Private Attributes

static constexpr std::array< double, 10 > elevations
 Elevations [rad]. Checks to smaller or equal than the value.
 

Friends

void from_json (const json &j, SNRMask &obj)
 Converts the provided json object into a node object.
 
void to_json (json &j, const SNRMask &obj)
 Converts the provided object into json.
 

Detailed Description

Signal to Noise Ratio Mask.

Member Function Documentation

◆ checkSNRMask()

bool NAV::SNRMask::checkSNRMask ( Frequency freq,
double elevation,
double SNR ) const
nodiscard

Checks wether the SNR values passes the SNR mask.

Parameters
[in]freqFrequency of the signal
[in]elevationElevation in [rad] of the satellite transmitting the signal
[in]SNRSignal to Noise Ratio in [dbHz]
Returns
True if the value passed the mask

◆ ShowGuiWidgets()

bool NAV::SNRMask::ShowGuiWidgets ( const char * label = nullptr)

Shows a button to select the SNR Mask.

Parameters
[in]labelText to display on the button. If empty, just 'SNR Mask' will be written

Friends And Related Symbol Documentation

◆ from_json

void from_json ( const json & j,
SNRMask & obj )
friend

Converts the provided json object into a node object.

Parameters
[in]jJson object with the needed values
[out]objObject to fill from the json

◆ to_json

void to_json ( json & j,
const SNRMask & obj )
friend

Converts the provided object into json.

Parameters
[out]jJson object which gets filled with the info
[in]objObject to convert into json

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