@ref SatelliteType Bitmask Support

Detailed Description

These values can be used to specify a bitmask for controlling enabled GNSS constellations. The bit locations are equal to the values set by SatelliteType for each constellation.

For example, the mask 0x32 enables GPS, Galileo, and BeiDou. You can create that mask with the SATELLITE_TYPE_MASK_* constants:

uint32_t mask = SATELLITE_TYPE_MASK_GPS | SATELLITE_TYPE_MASK_GALILEO |
                SATELLITE_TYPE_MASK_BEIDOU;

or by calling the ToBitMask(SatelliteType) helper function:

uint32_t mask = ToBitMask(SatelliteType::GPS, SatelliteType::GALILEO,
                          SatelliteType::BEIDOU);

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

Variables
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_ALL = 0xFFFFFFFF
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_BEIDOU
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GALILEO
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GLONASS
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GPS
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_IRNSS
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_LEO
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_MIXED
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_QZSS
static constexpr uint32_t	point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_SBAS

Function Documentation

ToBitMask() [1/2]

template<typename... Args>

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

constexpr

Convert two or more SatelliteType values to a bitmask.

For example:

uint32_t mask = ToBitMask(SatelliteType::GPS, SatelliteType::GALILEO,
                          SatelliteType::BEIDOU);

generates the following bitmask:

uint32_t mask = (1UL << static_cast<uint8_t>(SatelliteType::GPS)) |
                (1UL << static_cast<uint8_t>(SatelliteType::GALILEO)) |
                (1UL << static_cast<uint8_t>(SatelliteType::BEIDOU));

Template Parameters

Args	The type of the others values (SatelliteType)

Parameters

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

Returns

The corresponding bitmask.

Definition at line 192 of file signal_defs.h.

ToBitMask() [2/2]

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

constexpr

Convert a SatelliteType to a corresponding constellation control bitmask value.

For example:

uint32_t mask = ToBitMask(SatelliteType::GPS);

generates the following bitmask:

uint32_t mask = (1UL << static_cast<uint8_t>(SatelliteType::GPS));

Parameters

type	The desired constellation.

Returns

The corresponding bitmask.

Definition at line 163 of file signal_defs.h.

Variable Documentation

SATELLITE_TYPE_MASK_ALL

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

staticconstexpr

Definition at line 141 of file signal_defs.h.

SATELLITE_TYPE_MASK_BEIDOU

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_BEIDOU

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::BEIDOU))

Definition at line 130 of file signal_defs.h.

SATELLITE_TYPE_MASK_GALILEO

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GALILEO

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::GALILEO))

Definition at line 128 of file signal_defs.h.

SATELLITE_TYPE_MASK_GLONASS

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GLONASS

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::GLONASS))

Definition at line 124 of file signal_defs.h.

SATELLITE_TYPE_MASK_GPS

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_GPS

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::GPS))

Definition at line 122 of file signal_defs.h.

SATELLITE_TYPE_MASK_IRNSS

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_IRNSS

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::IRNSS))

Definition at line 138 of file signal_defs.h.

SATELLITE_TYPE_MASK_LEO

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_LEO

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::LEO))

Definition at line 126 of file signal_defs.h.

SATELLITE_TYPE_MASK_MIXED

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_MIXED

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::MIXED))

Definition at line 134 of file signal_defs.h.

SATELLITE_TYPE_MASK_QZSS

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_QZSS

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::QZSS))

Definition at line 132 of file signal_defs.h.

SATELLITE_TYPE_MASK_SBAS

constexpr uint32_t point_one::fusion_engine::messages::SATELLITE_TYPE_MASK_SBAS

staticconstexpr

Initial value:

=
    (1UL << static_cast<uint8_t>(SatelliteType::SBAS))

Definition at line 136 of file signal_defs.h.