QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
Classes | Functions | Variables
QGC Namespace Reference

Classes

class  AutoSuspendGuard
 RAII guard for an atomic suspend flag: sets on construction, clears on destruction. More...
 
class  EdgeTriggeredCounter
 

Functions

void showAppMessage (const QString &message, const QString &title=QString())
 Modal application message. Queued if the UI isn't ready yet.
 
void showCriticalVehicleMessage (const QString &message)
 
void showRebootAppMessage (const QString &message, const QString &title=QString())
 Modal reboot-required message. Debounced within 2 minutes.
 
bool runningUnitTests ()
 
QString numberToString (quint64 number)
 Decimal integer (e.g. "1,234,567").
 
QString bigSizeToString (quint64 size)
 Byte size with unit: B, KB, MB, GB, TB. 1 fractional digit above 1 KB.
 
QString bigSizeMBToString (quint64 sizeMB)
 MB-scaled size, output in MB/GB/TB. Input is in MB.
 
float limitAngleToPMPIf (double angle)
 
double limitAngleToPMPId (double angle)
 
quint32 crc32 (const quint8 *src, unsigned len, unsigned state)
 
bool fuzzyCompare (double value1, double value2)
 Returns true if the two values are equal or close. Correctly handles 0 and NaN values.
 
bool fuzzyCompare (double value1, double value2, double tolerance)
 
bool fuzzyCompare (float value1, float value2)
 
bool fuzzyCompare (float value1, float value2, float tolerance)
 
void secureZero (void *data, size_t size)
 
void secureZero (QByteArray &data)
 
template<typename T , size_t N>
void secureZero (std::array< T, N > &arr)
 

Variables

static const quint32 crctab []
 

Function Documentation

◆ bigSizeMBToString()

QString QGC::bigSizeMBToString ( quint64  sizeMB)

MB-scaled size, output in MB/GB/TB. Input is in MB.

Definition at line 38 of file QGCFormat.cc.

Referenced by VehicleCameraControl::storageFreeStr().

◆ bigSizeToString()

QString QGC::bigSizeToString ( quint64  size)

Byte size with unit: B, KB, MB, GB, TB. 1 fractional digit above 1 KB.

Definition at line 20 of file QGCFormat.cc.

Referenced by QGCCachedTileSet::savedTileSizeStr(), QGCOnboardLogEntry::sizeStr(), QGCOnboardLogFtpEntry::sizeStr(), QGCMapEngineManager::tileSizeStr(), QGCCachedTileSet::totalTilesSizeStr(), and QGCCachedTileSet::uniqueTileSizeStr().

◆ crc32()

quint32 QGC::crc32 ( const quint8 *  src,
unsigned  len,
unsigned  state 
)

Definition at line 100 of file QGCMath.cc.

References crctab.

◆ fuzzyCompare() [1/4]

bool QGC::fuzzyCompare ( double  value1,
double  value2 
)

Returns true if the two values are equal or close. Correctly handles 0 and NaN values.

Definition at line 109 of file QGCMath.cc.

Referenced by VisualMissionItem::setAltDifference(), VisualMissionItem::setAltPercent(), VisualMissionItem::setAzimuth(), FlightPathSegment::setCoord1AMSLAlt(), FlightPathSegment::setCoord2AMSLAlt(), VisualMissionItem::setDistance(), VisualMissionItem::setDistanceFromStart(), VisualMissionItem::setMissionFlightStatus(), SimpleMissionItem::setMissionFlightStatus(), StructureScanComplexItem::setMissionFlightStatus(), TransectStyleComplexItem::setMissionFlightStatus(), VisualMissionItem::setMissionVehicleYaw(), VisualMissionItem::setTerrainPercent(), ADSBVehicle::update(), and VTOLLandingComplexItem::VTOLLandingComplexItem().

◆ fuzzyCompare() [2/4]

bool QGC::fuzzyCompare ( double  value1,
double  value2,
double  tolerance 
)

Definition at line 122 of file QGCMath.cc.

◆ fuzzyCompare() [3/4]

bool QGC::fuzzyCompare ( float  value1,
float  value2 
)

Definition at line 133 of file QGCMath.cc.

◆ fuzzyCompare() [4/4]

bool QGC::fuzzyCompare ( float  value1,
float  value2,
float  tolerance 
)

Definition at line 146 of file QGCMath.cc.

◆ limitAngleToPMPId()

double QGC::limitAngleToPMPId ( double  angle)

Definition at line 36 of file QGCMath.cc.

◆ limitAngleToPMPIf()

float QGC::limitAngleToPMPIf ( double  angle)

Definition at line 13 of file QGCMath.cc.

◆ numberToString()

QString QGC::numberToString ( quint64  number)

Decimal integer (e.g. "1,234,567").

Definition at line 15 of file QGCFormat.cc.

Referenced by VehicleCameraControl::batteryRemainingStr(), QGCCachedTileSet::errorCountStr(), QGCCachedTileSet::savedTileCountStr(), QGCMapEngineManager::tileCountStr(), QGCCachedTileSet::totalTileCountStr(), and QGCCachedTileSet::uniqueTileCountStr().

◆ runningUnitTests()

bool QGC::runningUnitTests ( )

Definition at line 30 of file AppMessages.cc.

References qgcApp.

Referenced by FirmwarePlugin::_cachedParameterMetaDataFile(), PlanManager::_startAckTimeout(), SettingsManager::adjustSettingMetaData(), FirmwarePlugin::checkIfIsLatestStable(), DECLARE_SETTINGGROUP(), Fact::Fact(), FTPManager::FTPManager(), RequestMessageCoordinator::handleReceivedMessage(), LinkManager::init(), QGCPositionManager::init(), PX4AirframeLoader::loadAirframeMetaData(), ParameterManager::ParameterManager(), MockLink::run1HzTasks(), AudioOutput::say(), SettingsFact::SettingsFact(), TransectStyleComplexItem::TransectStyleComplexItem(), and Vehicle::Vehicle().

◆ secureZero() [1/3]

void QGC::secureZero ( QByteArray &  data)
inline

Reliable wipe only when this is the sole owner; data() detaches a shared buffer, leaving the original copy intact. Prefer std::array for secrets.

Definition at line 40 of file SecureMemory.h.

References secureZero().

◆ secureZero() [2/3]

template<typename T , size_t N>
void QGC::secureZero ( std::array< T, N > &  arr)
inline

Definition at line 49 of file SecureMemory.h.

References secureZero().

◆ secureZero() [3/3]

void QGC::secureZero ( void *  data,
size_t  size 
)
inline

Wipe size bytes of data. Uses platform-provided primitives that the spec or vendor docs guarantee are not elidable by the optimizer (explicit_bzero / SecureZeroMemory). Falls back to a volatile-pointer loop on platforms without one (including Apple).

Definition at line 19 of file SecureMemory.h.

Referenced by MAVLinkSigningKeys::addKey(), VehicleSigningController::disable(), SigningChannel::init(), MAVLinkSigningKeys::keyHexByName(), secureZero(), secureZero(), MAVLinkSigningKey::~MAVLinkSigningKey(), and SigningController::~SigningController().

◆ showAppMessage()

void QGC::showAppMessage ( const QString &  message,
const QString &  title 
)

Modal application message. Queued if the UI isn't ready yet.

Definition at line 9 of file AppMessages.cc.

References qgcApp.

Referenced by PX4FirmwarePlugin::_changeAltAfterPause(), LandingComplexItem::_load(), FirmwarePlugin::_versionFileDownloadFinished(), ParameterEditorController::buildDiffFromFile(), AirframeComponentController::changeAutostart(), DECLARE_SETTINGGROUP(), DECLARE_SETTINGGROUP(), ComplexMissionItem::deletePreset(), MissionManager::generateResumeMission(), Vehicle::guidedModeChangeAltitude(), FirmwarePlugin::guidedModeChangeAltitude(), APMFirmwarePlugin::guidedModeChangeAltitude(), ArduRoverFirmwarePlugin::guidedModeChangeAltitude(), PX4FirmwarePlugin::guidedModeChangeAltitude(), Vehicle::guidedModeChangeEquivalentAirspeedMetersSecond(), FirmwarePlugin::guidedModeChangeEquivalentAirspeedMetersSecond(), Vehicle::guidedModeChangeGroundSpeedMetersSecond(), FirmwarePlugin::guidedModeChangeGroundSpeedMetersSecond(), Vehicle::guidedModeChangeHeading(), FirmwarePlugin::guidedModeChangeHeading(), APMFirmwarePlugin::guidedModeChangeHeading(), PX4FirmwarePlugin::guidedModeChangeHeading(), Vehicle::guidedModeGotoLocation(), APMFirmwarePlugin::guidedModeGotoLocation(), PX4FirmwarePlugin::guidedModeGotoLocation(), FirmwarePlugin::guidedModeGotoLocation(), Vehicle::guidedModeLand(), FirmwarePlugin::guidedModeLand(), Vehicle::guidedModeOrbit(), Vehicle::guidedModeROI(), Vehicle::guidedModeRTL(), FirmwarePlugin::guidedModeRTL(), Vehicle::guidedModeTakeoff(), FirmwarePlugin::guidedModeTakeoff(), PX4FirmwarePlugin::guidedModeTakeoff(), PlanMasterController::loadFromArchive(), PlanMasterController::loadFromFile(), PlanMasterController::loadFromVehicle(), QGCMapPolygon::loadKMLOrSHPFile(), QGCMapPolyline::loadKMLOrSHPFile(), APMAirframeComponentController::loadParameters(), ComplexMissionItem::loadPreset(), CorridorScanComplexItem::loadPreset(), SurveyComplexItem::loadPreset(), MAVLinkProtocol::logSentBytes(), RemoteControlCalibrationController::nextButtonClicked(), AutoPilotPlugin::parametersReadyPreChecks(), PX4AutoPilotPlugin::parametersReadyPreChecks(), Vehicle::pauseVehicle(), FirmwarePlugin::pauseVehicle(), LinkInterface::reportMavlinkV1Traffic(), ComplexMissionItem::savePreset(), PlanMasterController::saveToFile(), ParameterEditorController::saveToFile(), PlanMasterController::saveToKml(), APMFirmwarePlugin::sendGCSMotionReport(), PlanMasterController::sendToVehicle(), MavCommandQueue::sendWorker(), FirmwarePlugin::setGuidedMode(), ShowAppMessageState::ShowAppMessageState(), MavCommandQueue::showCommandAckError(), FirmwarePlugin::startMission(), APMFirmwarePlugin::startMission(), PX4FirmwarePlugin::startMission(), VideoManager::startRecording(), FirmwarePlugin::startTakeoff(), APMFirmwarePlugin::startTakeoff(), PX4FirmwarePlugin::startTakeoff(), Vehicle::stopGuidedModeROI(), SimulatedCameraControl::takePhoto(), and VehicleCameraControl::takePhoto().

◆ showCriticalVehicleMessage()

void QGC::showCriticalVehicleMessage ( const QString &  message)

Non-modal vehicle message. PreArm/preflight messages are suppressed here; they're routed through the Vehicle path instead.

Definition at line 16 of file AppMessages.cc.

References qgcApp.

◆ showRebootAppMessage()

void QGC::showRebootAppMessage ( const QString &  message,
const QString &  title 
)

Modal reboot-required message. Debounced within 2 minutes.

Definition at line 23 of file AppMessages.cc.

References qgcApp.

Variable Documentation

◆ crctab

const quint32 QGC::crctab[]
static

Definition at line 64 of file QGCMath.cc.

Referenced by crc32().