GPSIntegrityReport Struct Reference

#include <GPSReceiverReports.h>

Collaboration diagram for GPSIntegrityReport:

Classes
struct	Antenna
struct	Jamming
struct	Spoofing

Public Types
enum class	JammingState { Unknown , Ok , Warning , Critical }
enum class	SpoofingState { Unknown , None , Indicated , Multiple }
enum class	AntennaState { Unknown , Ok , Open , Short }
	Ordered by severity, so the worst of several reports is the greatest. More...

Public Member Functions
GPSIntegrityReport	freshAt (uint64_t nowUs, std::chrono::microseconds maximumAge=DIAGNOSTIC_MAX_AGE) const
	Project independent diagnostic groups at the consumer's monotonic time.

Static Public Member Functions
static constexpr JammingState	jammingStateFromValue (int value)
static constexpr SpoofingState	spoofingStateFromValue (int value)

Public Attributes
uint64_t	timestampUs = 0
Jamming	jamming {}
Spoofing	spoofing {}
Antenna	antenna {}
uint64_t	outputOverflowUs = 0

Static Public Attributes
static constexpr std::chrono::microseconds	DIAGNOSTIC_MAX_AGE = std::chrono::seconds(5)
	Receipt age at which a diagnostic group reverts to unknown.

Detailed Description

Definition at line 53 of file GPSReceiverReports.h.

Member Enumeration Documentation

AntennaState

enum class GPSIntegrityReport::AntennaState

strong

Ordered by severity, so the worst of several reports is the greatest.

Enumerator
Unknown
Ok
Open
Short

Definition at line 70 of file GPSReceiverReports.h.

JammingState

enum class GPSIntegrityReport::JammingState

strong

Enumerator
Unknown
Ok
Warning
Critical

Definition at line 55 of file GPSReceiverReports.h.

SpoofingState

enum class GPSIntegrityReport::SpoofingState

strong

Enumerator
Unknown
None
Indicated
Multiple

Definition at line 62 of file GPSReceiverReports.h.

Member Function Documentation

freshAt()

GPSIntegrityReport GPSIntegrityReport::freshAt ( uint64_t  nowUs, std::chrono::microseconds  maximumAge = DIAGNOSTIC_MAX_AGE  ) const

inline

Project independent diagnostic groups at the consumer's monotonic time.

Definition at line 123 of file GPSReceiverReports.h.

References antenna, MonotonicClock::fresh(), jamming, spoofing, GPSIntegrityReport::Jamming::state, GPSIntegrityReport::Jamming::timestampUs, GPSIntegrityReport::Spoofing::timestampUs, GPSIntegrityReport::Antenna::timestampUs, and Unknown.

jammingStateFromValue()

static constexpr JammingState GPSIntegrityReport::jammingStateFromValue ( int  value )

inlinestaticconstexpr

Definition at line 78 of file GPSReceiverReports.h.

References Critical, and Unknown.

Referenced by GPSDecodedData::position().

spoofingStateFromValue()

static constexpr SpoofingState GPSIntegrityReport::spoofingStateFromValue ( int  value )

inlinestaticconstexpr

Definition at line 85 of file GPSReceiverReports.h.

References Multiple, and Unknown.

Referenced by GPSDecodedData::position().

Member Data Documentation

antenna

Antenna GPSIntegrityReport::antenna {}

Definition at line 114 of file GPSReceiverReports.h.

Referenced by freshAt().

DIAGNOSTIC_MAX_AGE

constexpr std::chrono::microseconds GPSIntegrityReport::DIAGNOSTIC_MAX_AGE = std::chrono::seconds(5)

staticconstexpr

Receipt age at which a diagnostic group reverts to unknown.

Definition at line 120 of file GPSReceiverReports.h.

jamming

Jamming GPSIntegrityReport::jamming {}

Definition at line 112 of file GPSReceiverReports.h.

Referenced by freshAt(), and GPSDecodedData::position().

outputOverflowUs

uint64_t GPSIntegrityReport::outputOverflowUs = 0

Receipt of the latest report that the receiver dropped output its connection could not carry; zero when none. Consumers decide how long it stays relevant.

Definition at line 117 of file GPSReceiverReports.h.

spoofing

Spoofing GPSIntegrityReport::spoofing {}

Definition at line 113 of file GPSReceiverReports.h.

Referenced by freshAt(), and GPSDecodedData::position().

timestampUs

uint64_t GPSIntegrityReport::timestampUs = 0

Definition at line 111 of file GPSReceiverReports.h.

Referenced by GPSDecodedData::position(), and GPSDecodeContext::publishIntegrity().

---

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

• src/GPS/Core/Common/GPSReceiverReports.h