@ref FrequencyBand Bitmask Support

Detailed Description

These values can be used to specify a bitmask for controlling enabled GNSS frequency bands. The bit locations are equal to the values set by FrequencyBand.

For example, the mask 0x22 enables L1 and L5. You can create that mask with the FREQUENCY_BAND_MASK_* constants:

uint32_t mask = FREQUENCY_BAND_MASK_L1 | FREQUENCY_BAND_MASK_L5;

or by calling the ToBitMask(FrequencyBand) helper function:

uint32_t mask = ToBitMask(FrequencyBand::L1, FrequencyBand::L5);

Functions
template<typename... Args>
constexpr uint32_t	point_one::fusion_engine::messages::ToBitMask (FrequencyBand first, Args... others)
	Convert two or more FrequencyBand values to a bitmask. More...
constexpr uint32_t	point_one::fusion_engine::messages::ToBitMask (FrequencyBand type)
	Convert a FrequencyBand to a corresponding frequency control bitmask value. More...

Variables
static constexpr uint32_t	point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_ALL = 0xFFFFFFFF
static constexpr uint32_t	point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L1
static constexpr uint32_t	point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L2
static constexpr uint32_t	point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L5
static constexpr uint32_t	point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L6

Function Documentation

ToBitMask() [1/2]

template<typename... Args>

constexpr uint32_t point_one::fusion_engine::messages::ToBitMask ( FrequencyBand  first, Args...  others  )

constexpr

Convert two or more FrequencyBand values to a bitmask.

For example:

uint32_t mask = ToBitMask(FrequencyBand::L1, FrequencyBand::L5);

generates the following bitmask:

uint32_t mask = (1UL << static_cast<uint8_t>(FrequencyBand::L1)) |
                (1UL << static_cast<uint8_t>(FrequencyBand::L5));

Template Parameters

Args	The type of the others values (FrequencyBand)

Parameters

first	The first value.
others	One or more additional values.

Returns

The corresponding bitmask.

Definition at line 359 of file signal_defs.h.

ToBitMask() [2/2]

constexpr uint32_t point_one::fusion_engine::messages::ToBitMask ( FrequencyBand  type )

constexpr

Convert a FrequencyBand to a corresponding frequency control bitmask value.

For example:

uint32_t mask = ToBitMask(FrequencyBand::L1);

generates the following bitmask:

uint32_t mask = (1UL << static_cast<uint8_t>(FrequencyBand::L1));

Parameters

type	The desired frequency band.

Returns

The corresponding bitmask.

Definition at line 332 of file signal_defs.h.

Variable Documentation

FREQUENCY_BAND_MASK_ALL

constexpr uint32_t point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_ALL = 0xFFFFFFFF

staticconstexpr

Definition at line 310 of file signal_defs.h.

FREQUENCY_BAND_MASK_L1

constexpr uint32_t point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L1

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(FrequencyBand::L1))

Definition at line 301 of file signal_defs.h.

FREQUENCY_BAND_MASK_L2

constexpr uint32_t point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L2

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(FrequencyBand::L2))

Definition at line 303 of file signal_defs.h.

FREQUENCY_BAND_MASK_L5

constexpr uint32_t point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L5

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(FrequencyBand::L5))

Definition at line 305 of file signal_defs.h.

FREQUENCY_BAND_MASK_L6

constexpr uint32_t point_one::fusion_engine::messages::FREQUENCY_BAND_MASK_L6

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(FrequencyBand::L6))

Definition at line 307 of file signal_defs.h.