QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
Public Attributes | List of all members
GPSReceiverFamily Struct Reference

#include <GPSFamilyProtocol.h>

+ Collaboration diagram for GPSReceiverFamily:

Public Attributes

GPSType type = GPSType::passive
 
GPSLogCategory logCategory = nullptr
 
GPSStreamConfig stream {}
 
std::span< const unsigned > baudCandidates {}
 
unsigned autoBaudRate = 0
 Rate passed to configure() when none is selected; zero requests detection.
 
std::unique_ptr< GPSFamilyProtocol >(* create )() = nullptr
 
GPSSignatureFunction signature = nullptr
 

Detailed Description

Static description of one receiver family. Each family defines one, its FAMILY, which the family table (GPSReceiverFamilies.cc) lists for type lookup. Its name and base-station capabilities come from the family's GPSReceiverDescriptor.

Definition at line 55 of file GPSFamilyProtocol.h.

Member Data Documentation

◆ autoBaudRate

unsigned GPSReceiverFamily::autoBaudRate = 0

Rate passed to configure() when none is selected; zero requests detection.

Definition at line 64 of file GPSFamilyProtocol.h.

Referenced by GPSDriver::configure().

◆ baudCandidates

std::span<const unsigned> GPSReceiverFamily::baudCandidates {}

Baud rates receiver detection probes the family at (GPSFamilyProtocol::probe()), in probing order; empty for a family it never detects, which then needs an explicit rate.

Definition at line 62 of file GPSFamilyProtocol.h.

◆ create

std::unique_ptr< GPSFamilyProtocol >(* GPSReceiverFamily::create) () = nullptr

Definition at line 64 of file GPSFamilyProtocol.h.

◆ logCategory

GPSLogCategory GPSReceiverFamily::logCategory = nullptr

Definition at line 58 of file GPSFamilyProtocol.h.

Referenced by GPSProtocolRuntime::logCategory().

◆ signature

GPSSignatureFunction GPSReceiverFamily::signature = nullptr

Receiver detection (GPSReceiverDetector) recognises the family's traffic with this, and its mismatch hints name the family; null when its traffic has no signature.

Definition at line 68 of file GPSFamilyProtocol.h.

◆ stream

GPSStreamConfig GPSReceiverFamily::stream {}

Definition at line 59 of file GPSFamilyProtocol.h.

◆ type

GPSType GPSReceiverFamily::type = GPSType::passive

Definition at line 57 of file GPSFamilyProtocol.h.

Referenced by GPSCommandChannel::failNoAnswer(), GPSProtocolRuntime::GPSProtocolRuntime(), gpsReceiverFamily(), and GPSCommandChannel::write().

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