QGCCommandLineParser::CommandLineParseResult Struct Reference

Result of parsing command-line arguments. More...

#include <QGCCommandLineParser.h>

Public Types
enum class	Status { Ok , Error , VersionRequested , HelpRequested }

Public Attributes
enum QGCCommandLineParser::CommandLineParseResult::Status	statusCode = Status::Ok
std::unique_ptr< QCommandLineParser >	parser
std::optional< QString >	errorString
QString	helpText
QString	versionText
QStringList	positional
QStringList	unknownOptions
std::optional< quint8 >	systemId
bool	clearSettingsOptions = false
bool	clearCache = false
std::optional< QString >	loggingOptions
bool	logOutput = false
bool	simpleBootTest = false
bool	runningUnitTests = false
QStringList	unitTests
bool	stressUnitTests = false
uint	stressUnitTestsCount = 0
std::optional< QString >	unitTestOutput
	Output file for test results (JUnit XML)
std::optional< QString >	labelFilter
	Filter tests by label (comma-separated)
bool	listTests = false
	List available tests and exit.
bool	fakeMobile = false
bool	allowMultiple = false
bool	useDesktopGL = false
	Windows only: Force Desktop OpenGL.
bool	useSwRast = false
	Windows/macOS: Force software OpenGL.
bool	quietWindowsAsserts = false
	Windows only: Disable assert dialogs.

Detailed Description

Result of parsing command-line arguments.

Contains all parsed options and status information. All fields are always present for ABI stability, but test-related command-line options are only available in QGC_UNITTEST_BUILD.

Definition at line 18 of file QGCCommandLineParser.h.

Member Enumeration Documentation

Status

enum class QGCCommandLineParser::CommandLineParseResult::Status

strong

Enumerator
Ok
Error
VersionRequested
HelpRequested

Definition at line 20 of file QGCCommandLineParser.h.

Member Data Documentation

allowMultiple

bool QGCCommandLineParser::CommandLineParseResult::allowMultiple = false

Definition at line 55 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

clearCache

bool QGCCommandLineParser::CommandLineParseResult::clearCache = false

Definition at line 39 of file QGCCommandLineParser.h.

clearSettingsOptions

bool QGCCommandLineParser::CommandLineParseResult::clearSettingsOptions = false

Definition at line 38 of file QGCCommandLineParser.h.

errorString

std::optional<QString> QGCCommandLineParser::CommandLineParseResult::errorString

Definition at line 29 of file QGCCommandLineParser.h.

fakeMobile

bool QGCCommandLineParser::CommandLineParseResult::fakeMobile = false

Definition at line 54 of file QGCCommandLineParser.h.

helpText

QString QGCCommandLineParser::CommandLineParseResult::helpText

Definition at line 30 of file QGCCommandLineParser.h.

labelFilter

std::optional<QString> QGCCommandLineParser::CommandLineParseResult::labelFilter

Filter tests by label (comma-separated)

Definition at line 50 of file QGCCommandLineParser.h.

listTests

bool QGCCommandLineParser::CommandLineParseResult::listTests = false

List available tests and exit.

Definition at line 51 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

loggingOptions

std::optional<QString> QGCCommandLineParser::CommandLineParseResult::loggingOptions

Definition at line 40 of file QGCCommandLineParser.h.

logOutput

bool QGCCommandLineParser::CommandLineParseResult::logOutput = false

Definition at line 41 of file QGCCommandLineParser.h.

parser

std::unique_ptr<QCommandLineParser> QGCCommandLineParser::CommandLineParseResult::parser

Definition at line 27 of file QGCCommandLineParser.h.

positional

QStringList QGCCommandLineParser::CommandLineParseResult::positional

Definition at line 33 of file QGCCommandLineParser.h.

quietWindowsAsserts

bool QGCCommandLineParser::CommandLineParseResult::quietWindowsAsserts = false

Windows only: Disable assert dialogs.

Definition at line 60 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

runningUnitTests

bool QGCCommandLineParser::CommandLineParseResult::runningUnitTests = false

Definition at line 45 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

simpleBootTest

bool QGCCommandLineParser::CommandLineParseResult::simpleBootTest = false

Definition at line 42 of file QGCCommandLineParser.h.

statusCode

enum QGCCommandLineParser::CommandLineParseResult::Status QGCCommandLineParser::CommandLineParseResult::statusCode = Status::Ok

stressUnitTests

bool QGCCommandLineParser::CommandLineParseResult::stressUnitTests = false

Definition at line 47 of file QGCCommandLineParser.h.

stressUnitTestsCount

uint QGCCommandLineParser::CommandLineParseResult::stressUnitTestsCount = 0

Definition at line 48 of file QGCCommandLineParser.h.

systemId

std::optional<quint8> QGCCommandLineParser::CommandLineParseResult::systemId

Definition at line 37 of file QGCCommandLineParser.h.

unitTestOutput

std::optional<QString> QGCCommandLineParser::CommandLineParseResult::unitTestOutput

Output file for test results (JUnit XML)

Definition at line 49 of file QGCCommandLineParser.h.

unitTests

QStringList QGCCommandLineParser::CommandLineParseResult::unitTests

Definition at line 46 of file QGCCommandLineParser.h.

unknownOptions

QStringList QGCCommandLineParser::CommandLineParseResult::unknownOptions

Definition at line 34 of file QGCCommandLineParser.h.

useDesktopGL

bool QGCCommandLineParser::CommandLineParseResult::useDesktopGL = false

Windows only: Force Desktop OpenGL.

Definition at line 58 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

useSwRast

bool QGCCommandLineParser::CommandLineParseResult::useSwRast = false

Windows/macOS: Force software OpenGL.

Definition at line 59 of file QGCCommandLineParser.h.

Referenced by Platform::initialize().

versionText

QString QGCCommandLineParser::CommandLineParseResult::versionText

Definition at line 31 of file QGCCommandLineParser.h.

---

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

• src/Utilities/QGCCommandLineParser.h