@ref FrequencyBand Bitmask Support

These values can be used to specify a bitmask for controlling enabled GNSS frequency bands. More...

Functions Index

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

Variables Index

static constexpr uint32_t	FREQUENCY_BAND_MASK_ALL = 0xFFFFFFFF
static constexpr uint32_t	FREQUENCY_BAND_MASK_L1 = ...
static constexpr uint32_t	FREQUENCY_BAND_MASK_L2 = ...
static constexpr uint32_t	FREQUENCY_BAND_MASK_L5 = ...
static constexpr uint32_t	FREQUENCY_BAND_MASK_L6 = ...

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

ToBitMask()

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 358 of file signal_defs.h.

358constexpr uint32_t ToBitMask(FrequencyBand first, Args... others) {

359 return ToBitMask(first) | ToBitMask(others...);

360}

ToBitMask()

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 331 of file signal_defs.h.

331constexpr uint32_t ToBitMask(FrequencyBand type) {

332 return (1U << (static_cast<uint8_t>(type)));

333}

Variables

FREQUENCY_BAND_MASK_ALL

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

constexpr static

Definition at line 309 of file signal_defs.h.

309static constexpr uint32_t FREQUENCY_BAND_MASK_ALL = 0xFFFFFFFF;

FREQUENCY_BAND_MASK_L1

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

constexpr static

Initialiser

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

Definition at line 300 of file signal_defs.h.

300static constexpr uint32_t FREQUENCY_BAND_MASK_L1 =

FREQUENCY_BAND_MASK_L2

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

constexpr static

Initialiser

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

Definition at line 302 of file signal_defs.h.

302static constexpr uint32_t FREQUENCY_BAND_MASK_L2 =

FREQUENCY_BAND_MASK_L5

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

constexpr static

Initialiser

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

Definition at line 304 of file signal_defs.h.

304static constexpr uint32_t FREQUENCY_BAND_MASK_L5 =

FREQUENCY_BAND_MASK_L6

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

constexpr static

Initialiser

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

Definition at line 306 of file signal_defs.h.

306static constexpr uint32_t FREQUENCY_BAND_MASK_L6 =

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.