0.5.0
Loading...
Searching...
No Matches
NAV::SatId Struct Reference

Identifies a satellite (satellite system and number) More...

Public Member Functions

bool isGeo () const
 Checks if the satellite is geostationary.
constexpr bool operator< (const SatId &rhs) const
 Less than comparison (needed for map)
constexpr bool operator== (const SatId &rhs) const
 Equal comparison (needed for unordered_map)
 SatId ()=default
 Default constructor.
 SatId (const std::string &str)
 Constructor from String representation.
 SatId (SatelliteSystem satSys, uint16_t satNum)
 Constructor.

Data Fields

uint16_t satNum
 Number of the satellite.
SatelliteSystem satSys
 Satellite system (GPS, GLONASS, GALILEO, QZSS, BDS, IRNSS, SBAS)

Detailed Description

Identifies a satellite (satellite system and number)

Definition at line 33 of file SatelliteIdentifier.hpp.

Constructor & Destructor Documentation

◆ SatId() [1/3]

NAV::SatId::SatId ( SatelliteSystem satSys,
uint16_t satNum )
inline

Constructor.

Parameters
[in]satSysSatellite system
[in]satNumNumber of the satellite

Definition at line 38 of file SatelliteIdentifier.hpp.

◆ SatId() [2/3]

NAV::SatId::SatId ( )
default

Default constructor.

◆ SatId() [3/3]

NAV::SatId::SatId ( const std::string & str)
inlineexplicit

Constructor from String representation.

Parameters
[in]strSatId as string

Definition at line 46 of file SatelliteIdentifier.hpp.

Member Function Documentation

◆ isGeo()

bool NAV::SatId::isGeo ( ) const
nodiscard

Checks if the satellite is geostationary.

Definition at line 23 of file SatelliteIdentifier.cpp.

◆ operator<()

bool NAV::SatId::operator< ( const SatId & rhs) const
inlineconstexpr

Less than comparison (needed for map)

Parameters
[in]rhsRight hand side of the operator
Returns
True if lhs < rhs

Definition at line 61 of file SatelliteIdentifier.hpp.

◆ operator==()

bool NAV::SatId::operator== ( const SatId & rhs) const
inlineconstexpr

Equal comparison (needed for unordered_map)

Parameters
[in]rhsRight hand side of the operator
Returns
True if the elements are equal

Definition at line 56 of file SatelliteIdentifier.hpp.

Field Documentation

◆ satNum

uint16_t NAV::SatId::satNum

Number of the satellite.

Definition at line 51 of file SatelliteIdentifier.hpp.

◆ satSys

SatelliteSystem NAV::SatId::satSys

Satellite system (GPS, GLONASS, GALILEO, QZSS, BDS, IRNSS, SBAS)

Definition at line 50 of file SatelliteIdentifier.hpp.


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