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.

Definition at line 25 of file SNRMask.hpp.

Constructor & Destructor Documentation

SNRMask()

NAV::SNRMask::SNRMask

(

)

Default Constructor.

Definition at line 25 of file SNRMask.cpp.

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]	freq	Frequency of the signal
[in]	elevation	Elevation in [rad] of the satellite transmitting the signal
[in]	SNR	Signal to Noise Ratio in [dbHz]

Returns

True if the value passed the mask

Definition at line 181 of file SNRMask.cpp.

disable()

void NAV::SNRMask::disable ( )

inline

Disables the SNR mask by setting all values to 0.

Definition at line 46 of file SNRMask.hpp.

isInactive()

bool NAV::SNRMask::isInactive ( ) const

nodiscard

Checks wether all SNR values are 0.

Definition at line 172 of file SNRMask.cpp.

ShowGuiWidgets()

bool NAV::SNRMask::ShowGuiWidgets

(

const char *

label = nullptr

)

Shows a button to select the SNR Mask.

Parameters

[in]

label

Text to display on the button. If empty, just 'SNR Mask' will be written

Definition at line 35 of file SNRMask.cpp.

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]	j	Json object with the needed values
[out]	obj	Object to fill from the json

Definition at line 208 of file SNRMask.cpp.

to_json

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

friend

Converts the provided object into json.

Parameters

[out]	j	Json object which gets filled with the info
[in]	obj	Object to convert into json

Definition at line 200 of file SNRMask.cpp.

Field Documentation

allOverride

std::pair<std::array<double, elevations.size()>, bool> NAV::SNRMask::allOverride

private

Values when changed override all others.

Definition at line 73 of file SNRMask.hpp.

elevations

std::array<double, 10> NAV::SNRMask::elevations

staticconstexprprivate

Elevations [rad]. Checks to smaller or equal than the value.

Definition at line 59 of file SNRMask.hpp.

mask

std::array<std::pair<Frequency, std::pair<std::array<double, elevations.size()>, bool> >, Frequency::GetAll().size()> NAV::SNRMask::mask

private

Masks for all frequencies and SNR [dbHz] values + lock together boolean.

Definition at line 76 of file SNRMask.hpp.

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/Navigation/GNSS/SNRMask.hpp
• /home/runner/work/INSTINCT/INSTINCT/src/Navigation/GNSS/SNRMask.cpp