Dokit
Internal development documentation
Loading...
Searching...
No Matches
AbstractCommand Class Referenceabstract

The AbstractCommand class provides a consistent base for the classes that implement CLI commands. More...

Inheritance diagram for AbstractCommand:
[legend]
Collaboration diagram for AbstractCommand:
[legend]

Public Types

enum class  OutputFormat { Csv , Json , Text }
 Supported output formats. More...
 

Public Slots

virtual QStringList processOptions (const QCommandLineParser &parser)
 Processes the relevant options from the command line parser.
 
virtual bool start ()=0
 Begins the functionality of this command, and returns true if begun successfully, false otherwise.
 

Public Member Functions

 AbstractCommand (QObject *const parent=nullptr)
 Constructs a new command with parent.
 
virtual QStringList requiredOptions (const QCommandLineParser &parser) const
 Returns a list of CLI option names required by this command.
 
virtual QStringList supportedOptions (const QCommandLineParser &parser) const
 Returns a list of CLI option names supported by this command.
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
 QObject (QObject *parent)
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
const QObjectListchildren () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
 Q_CLASSINFO (Name, Value)
 
 Q_INTERFACES (...)
 
 Q_PROPERTY (...)
 
 Q_ENUMS (...)
 
 Q_FLAGS (...)
 
 Q_ENUM (...)
 
 Q_FLAG (...)
 
 Q_ENUM_NS (...)
 
 Q_FLAG_NS (...)
 
 Q_OBJECT Q_OBJECT
 
 Q_GADGET Q_GADGET
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SLOTS Q_SLOTS
 
 Q_SLOT Q_SLOT
 
 Q_EMIT Q_EMIT
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 

Static Public Member Functions

static QString escapeCsvField (const QString &field)
 Returns an RFC 4180 compliant version of field.
 
template<typename R >
static quint32 parseNumber (const QString &value, const QString &unit, const quint32 sensibleMinimum=0)
 Returns value as an integer multiple of the ratio R.
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 

Protected Slots

virtual void deviceDiscovered (const QBluetoothDeviceInfo &info)=0
 Handles PokitDiscoveryAgent::pokitDeviceDiscovered signal.
 
virtual void deviceDiscoveryFinished ()=0
 Handles PokitDiscoveryAgent::deviceDiscoveryFinished signal.
 

Static Protected Member Functions

static Q_LOGGING_CATEGORY (lc, "dokit.cli.command", QtInfoMsg)
 Logging category for UI commands.
 

Protected Attributes

QString deviceToScanFor
 Device (if any) that were passed to processOptions().
 
PokitDiscoveryAgentdiscoveryAgent
 Agent for Pokit device descovery.
 
OutputFormat format { OutputFormat::Text }
 Selected output format.
 

Friends

class TestAbstractCommand
 

Additional Inherited Members

- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The AbstractCommand class provides a consistent base for the classes that implement CLI commands.

Definition at line 14 of file abstractcommand.h.

Member Enumeration Documentation

◆ OutputFormat

enum class AbstractCommand::OutputFormat
strong

Supported output formats.

Enumerator
Csv 

RFC 4180 compliant CSV text.

Json 

RFC 8259 compliant JSON text.

Text 

Plain unstructured text.

Definition at line 20 of file abstractcommand.h.

20 {
21 Csv, ///< RFC 4180 compliant CSV text.
22 Json, ///< RFC 8259 compliant JSON text.
23 Text, ///< Plain unstructured text.
24 };
@ Text
Plain unstructured text.
@ Csv
RFC 4180 compliant CSV text.
@ Json
RFC 8259 compliant JSON text.

Constructor & Destructor Documentation

◆ AbstractCommand()

AbstractCommand::AbstractCommand ( QObject *const parent = nullptr)
explicit

Constructs a new command with parent.

Definition at line 24 of file abstractcommand.cpp.

24 : QObject(parent),
26{
32 #if (QT_VERSION < QT_VERSION_CHECK(6, 2, 0))
33 QOverload<PokitDiscoveryAgent::Error>::of(&PokitDiscoveryAgent::error),
34 #else
35 &PokitDiscoveryAgent::errorOccurred,
36 #endif
37 this, [](const PokitDiscoveryAgent::Error &error) {
38 qCWarning(lc).noquote() << tr("Bluetooth discovery error:") << error;
40 QCoreApplication::exit(EXIT_FAILURE);
41 });
42 });
43}
virtual void deviceDiscovered(const QBluetoothDeviceInfo &info)=0
Handles PokitDiscoveryAgent::pokitDeviceDiscovered signal.
PokitDiscoveryAgent * discoveryAgent
Agent for Pokit device descovery.
virtual void deviceDiscoveryFinished()=0
Handles PokitDiscoveryAgent::deviceDiscoveryFinished signal.
The PokitDiscoveryAgent class discovers nearby Pokit devices.
void pokitDeviceDiscovered(const QBluetoothDeviceInfo &info)
This signal is emitted when the Pokit device described by info is discovered.
QBluetoothDeviceDiscoveryAgent::Error error() const const
void exit(int returnCode)
QCoreApplication * instance()
QObject(QObject *parent)
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QObject * parent() const const
QString tr(const char *sourceText, const char *disambiguation, int n)

References QObject::connect(), deviceDiscovered(), deviceDiscoveryFinished(), discoveryAgent, QBluetoothDeviceDiscoveryAgent::error(), QCoreApplication::exit(), QBluetoothDeviceDiscoveryAgent::finished(), QCoreApplication::instance(), PokitDiscoveryAgent::pokitDeviceDiscovered(), QTimer::singleShot, and QObject::tr().

Here is the call graph for this function:

Member Function Documentation

◆ deviceDiscovered

virtual void AbstractCommand::deviceDiscovered ( const QBluetoothDeviceInfo & info)
protectedpure virtualslot

Handles PokitDiscoveryAgent::pokitDeviceDiscovered signal.

Derived classes must implement this slot to begin whatever actions are relevant when a Pokit device has been discovered. For example, the 'scan' command would simply output the info details, whereas most other commands would begin connecting if info is the device they're after.

Referenced by AbstractCommand().

Here is the caller graph for this function:

◆ deviceDiscoveryFinished

virtual void AbstractCommand::deviceDiscoveryFinished ( )
protectedpure virtualslot

Handles PokitDiscoveryAgent::deviceDiscoveryFinished signal.

Derived classes must implement this slot to perform whatever actions are appropraite when discovery is finished. For example, the 'scan' command would simply exit, whereas most other commands would verify that an appropriate device was found.

Referenced by AbstractCommand().

Here is the caller graph for this function:

◆ escapeCsvField()

QString AbstractCommand::escapeCsvField ( const QString & field)
static

Returns an RFC 4180 compliant version of field.

That is, if field contains any of the the below four characters, than any double quotes are escaped (by addition double-quotes), and the string itself surrounded in double-quotes. Otherwise, field is returned verbatim.

Some examples:

QCOMPARE(escapeCsvField("abc"), "abc"); // Returned unchanged.
QCOMPARE(escapeCsvField("a,c"), R"("a,c")"); // Wrapped in double-quotes.
QCOMPARE(escapeCsvField(R"(a"c)"), R("("a""c")"); // Existing double-quotes doubled, then wrapped.
static QString escapeCsvField(const QString &field)
Returns an RFC 4180 compliant version of field.

Definition at line 106 of file abstractcommand.cpp.

107{
108 if (field.contains(QLatin1Char(','))||field.contains(QLatin1Char('\r'))||
109 field.contains(QLatin1Char('"'))||field.contains(QLatin1Char('\n')))
110 {
111 return QString::fromLatin1(R"("%1")").arg(
112 QString(field).replace(QLatin1Char('"'), QLatin1String(R"("")")));
113 } else return field;
114}
QString arg(qlonglong a, int fieldWidth, int base, QChar fillChar) const const
bool contains(QChar ch, Qt::CaseSensitivity cs) const const
QString fromLatin1(const char *str, int size)

References QString::arg(), QString::contains(), and QString::fromLatin1().

Referenced by ScanCommand::deviceDiscovered(), StatusCommand::outputDeviceStatus(), MeterCommand::outputReading(), and InfoCommand::serviceDetailsDiscovered().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parseNumber()

template<typename R >
quint32 AbstractCommand::parseNumber ( const QString & value,
const QString & unit,
const quint32 sensibleMinimum = 0 )
static

Returns value as an integer multiple of the ratio R.

The string value may end with the optional unit, such as V or s, which may also be preceded with a SI unit prefix such as m for milli. If value contains no SI unit prefix, then the result will be multiplied by 1,000 enough times to be greater than sensibleMinimum. This allows for convenient use like:

const quint32 timeout = parseNumber<std::milli>(parser.value("window"), 's', 500'000);
static quint32 parseNumber(const QString &value, const QString &unit, const quint32 sensibleMinimum=0)
Returns value as an integer multiple of the ratio R.

So that an unqalified period like "300" will be assumed to be 300 milliseconds, and not 300 microseconds, while a period like "1000" will be assume to be 1 second.

If conversion fails for any reason, 0 is returned.

Definition at line 150 of file abstractcommand.cpp.

151{
152 static const QMap<QChar, Ratio> unitPrefixScaleMap {
153 { QLatin1Char('E'), makeRatio<std::exa>() },
154 { QLatin1Char('P'), makeRatio<std::peta>() },
155 { QLatin1Char('T'), makeRatio<std::tera>() },
156 { QLatin1Char('G'), makeRatio<std::giga>() },
157 { QLatin1Char('M'), makeRatio<std::mega>() },
158 { QLatin1Char('K'), makeRatio<std::kilo>() }, // Not official SI unit prefix, but commonly used.
159 { QLatin1Char('k'), makeRatio<std::kilo>() },
160 { QLatin1Char('h'), makeRatio<std::hecto>() },
161 { QLatin1Char('d'), makeRatio<std::deci>() },
162 { QLatin1Char('c'), makeRatio<std::centi>() },
163 { QLatin1Char('m'), makeRatio<std::milli>() },
164 { QLatin1Char('u'), makeRatio<std::micro>() }, // Not official SI unit prefix, but commonly used.
165 { QChar (0x00B5), makeRatio<std::micro>() }, // Unicode micro symbol (μ).
166 { QLatin1Char('n'), makeRatio<std::nano>() },
167 { QLatin1Char('p'), makeRatio<std::pico>() },
168 { QLatin1Char('f'), makeRatio<std::femto>() },
169 { QLatin1Char('a'), makeRatio<std::atto>() },
170 };
171
172 // Remove the optional (whole) unit suffix.
173 Ratio ratio;
174 QString number = value.trimmed();
175 if ((!unit.isEmpty()) && (number.endsWith(unit, Qt::CaseInsensitive))) {
176 number.chop(unit.length());
177 ratio = makeRatio<std::ratio<1>>();
178 }
179
180 // Parse, and remove, the optional SI unit prefix.
181 if (!number.isEmpty()) {
182 #if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0))
183 const QChar siPrefix = number.back(); // QString::back() introduced in Qt 5.10.
184 #else
185 const QChar siPrefix = number.at(number.size() - 1);
186 #endif
187 const auto iter = unitPrefixScaleMap.constFind(siPrefix);
188 if (iter != unitPrefixScaleMap.constEnd()) {
189 Q_ASSERT(iter->isValid());
190 ratio = *iter;
191 number.chop(1);
192 }
193 }
194
195 #define DOKIT_RESULT(var) (var * ratio.num * R::den / ratio.den / R::num)
196 // Parse the number as an (unsigned) integer.
197 QLocale locale; bool ok;
198 qulonglong integer = locale.toULongLong(number, &ok);
199 if (ok) {
200 if (integer == 0) {
201 return 0;
202 }
203 if (!ratio.isValid()) {
204 for (ratio = makeRatio<R>(); DOKIT_RESULT(integer) < sensibleMinimum; ratio.num *= 1000);
205 }
206 return (integer == 0) ? 0u : (quint32)DOKIT_RESULT(integer);
207 }
208
209 // Parse the number as a (double) floating point number, and check that it is positive.
210 if (const double dbl = locale.toDouble(number, &ok); (ok) && (dbl > 0.0)) {
211 if (!ratio.isValid()) {
212 for (ratio = makeRatio<R>(); DOKIT_RESULT(dbl) < sensibleMinimum; ratio.num *= 1000);
213 }
214 return static_cast<quint32>(std::llround(DOKIT_RESULT(dbl)));
215 }
216 #undef DOKIT_RESULT
217 return 0; // Failed to parse as either integer, or float.
218}
double toDouble(const QString &s, bool *ok) const const
qulonglong toULongLong(const QString &s, bool *ok) const const
const QChar at(int position) const const
QChar back() const const
void chop(int n)
bool endsWith(const QString &s, Qt::CaseSensitivity cs) const const
bool isEmpty() const const
int length() const const
int size() const const
QString trimmed() const const
CaseInsensitive
std::intmax_t num
Numerator.
bool isValid() const
Returns true if both num and den are non-zero.

References QString::at(), QString::back(), Qt::CaseInsensitive, QString::chop(), QString::endsWith(), QString::isEmpty(), Ratio::isValid(), QString::length(), Ratio::num, QString::size(), QLocale::toDouble(), QLocale::toULongLong(), and QString::trimmed().

Referenced by processOptions(), DsoCommand::processOptions(), LoggerStartCommand::processOptions(), and MeterCommand::processOptions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ processOptions

QStringList AbstractCommand::processOptions ( const QCommandLineParser & parser)
virtualslot

Processes the relevant options from the command line parser.

On success, returns an empty QStringList, otherwise returns a list of CLI errors that the caller should report appropriately before exiting.

This base implementations performs some common checks, such as ensuring that required options are present. Derived classes should override this function to perform further processing, typically inovking this base implementation as a first step, such as:

QStringList CustomCommand::processOptions(const QCommandLineParser &parser)
{
if (!errors.isEmpty()) {
return errors;
}
// Do further procession of options.
return errors;
}
virtual QStringList processOptions(const QCommandLineParser &parser)
Processes the relevant options from the command line parser.
bool isEmpty() const const

Definition at line 265 of file abstractcommand.cpp.

266{
267 // Report any supplied options that are not supported by this command.
268 const QStringList suppliedOptionNames = parser.optionNames();
269 const QStringList supportedOptionNames = supportedOptions(parser);
270 for (const QString &option: suppliedOptionNames) {
271 if (!supportedOptionNames.contains(option)) {
272 qCInfo(lc).noquote() << tr("Ignoring option: %1").arg(option);
273 }
274 }
275 QStringList errors;
276
277 // Parse the device (name/addr/uuid) option.
278 if (parser.isSet(QLatin1String("device"))) {
279 deviceToScanFor = parser.value(QLatin1String("device"));
280 }
281
282 // Parse the output format options (if supported, and supplied).
283 if ((supportedOptionNames.contains(QLatin1String("output"))) && // Derived classes may have removed.
284 (parser.isSet(QLatin1String("output"))))
285 {
286 const QString output = parser.value(QLatin1String("output")).toLower();
287 if (output == QLatin1String("csv")) {
289 } else if (output == QLatin1String("json")) {
291 } else if (output == QLatin1String("text")) {
293 } else {
294 errors.append(tr("Unknown output format: %1").arg(output));
295 }
296 }
297
298 // Parse the device scan timeout option.
299 if (parser.isSet(QLatin1String("timeout"))) {
300 const quint32 timeout = parseNumber<std::milli>(parser.value(QLatin1String("timeout")), QLatin1String("s"), 500);
301 if (timeout == 0) {
302 errors.append(tr("Invalid timeout: %1").arg(parser.value(QLatin1String("timeout"))));
303 } else if (discoveryAgent->lowEnergyDiscoveryTimeout() == -1) {
304 qCWarning(lc).noquote() << tr("Platform does not support Bluetooth scan timeout");
305 } else {
307 qCDebug(lc).noquote() << tr("Set scan timeout to %1").arg(
309 }
310 }
311
312 // Return errors for any required options that are absent.
313 const QStringList requiredOptionNames = this->requiredOptions(parser);
314 for (const QString &option: requiredOptionNames) {
315 if (!parser.isSet(option)) {
316 errors.append(tr("Missing required option: %1").arg(option));
317 }
318 }
319 return errors;
320}
QString deviceToScanFor
Device (if any) that were passed to processOptions().
virtual QStringList supportedOptions(const QCommandLineParser &parser) const
Returns a list of CLI option names supported by this command.
OutputFormat format
Selected output format.
virtual QStringList requiredOptions(const QCommandLineParser &parser) const
Returns a list of CLI option names required by this command.
int lowEnergyDiscoveryTimeout() const const
void setLowEnergyDiscoveryTimeout(int timeout)
bool isSet(const QString &name) const const
QStringList optionNames() const const
QString value(const QString &optionName) const const
void append(const T &value)
QString toLower() const const
bool contains(const QString &str, Qt::CaseSensitivity cs) const const

References QList::append(), QString::arg(), QStringList::contains(), Csv, deviceToScanFor, discoveryAgent, format, QCommandLineParser::isSet(), Json, QBluetoothDeviceDiscoveryAgent::lowEnergyDiscoveryTimeout(), QCommandLineParser::optionNames(), parseNumber(), requiredOptions(), QBluetoothDeviceDiscoveryAgent::setLowEnergyDiscoveryTimeout(), supportedOptions(), Text, QString::toLower(), QObject::tr(), and QCommandLineParser::value().

Referenced by CalibrateCommand::processOptions(), DsoCommand::processOptions(), FlashLedCommand::processOptions(), InfoCommand::processOptions(), LoggerStartCommand::processOptions(), MeterCommand::processOptions(), ScanCommand::processOptions(), SetNameCommand::processOptions(), SetTorchCommand::processOptions(), and StatusCommand::processOptions().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ requiredOptions()

QStringList AbstractCommand::requiredOptions ( const QCommandLineParser & parser) const
virtual

Returns a list of CLI option names required by this command.

The main console appication may use this list to output an eror (and exit) if any of the returned names are not found in the parsed CLI options.

The (already parsed) parser may be used adjust the returned required options depending on the value of other options. For example, the logger command only requires the --mode option if the --command option is start.

This base implementation simply returns an empty list. Derived classes should override this function to include any required options.

Reimplemented in CalibrateCommand, DsoCommand, FlashLedCommand, InfoCommand, LoggerStartCommand, MeterCommand, ScanCommand, SetNameCommand, SetTorchCommand, and StatusCommand.

Definition at line 57 of file abstractcommand.cpp.

58{
59 Q_UNUSED(parser)
60 return QStringList();
61}

Referenced by processOptions(), CalibrateCommand::requiredOptions(), DsoCommand::requiredOptions(), FlashLedCommand::requiredOptions(), InfoCommand::requiredOptions(), LoggerStartCommand::requiredOptions(), MeterCommand::requiredOptions(), ScanCommand::requiredOptions(), SetNameCommand::requiredOptions(), SetTorchCommand::requiredOptions(), StatusCommand::requiredOptions(), and supportedOptions().

Here is the caller graph for this function:

◆ supportedOptions()

QStringList AbstractCommand::supportedOptions ( const QCommandLineParser & parser) const
virtual

Returns a list of CLI option names supported by this command.

The main console appication may use this list to output a warning for any parsed CLI options not included in the returned list.

The (already parsed) parser may be used adjust the returned supported options depending on the value of other options. For example, the logger command only supported the --timestamp option if the --command option is start.

This base implementation simply returns requiredOptions(). Derived classes should override this function to include optional options, such as:

QStringList Derived::supportedOptions(const QCommandLineParser &parser) const
{
list.sort();
list.removeDuplicates(); // Optional, recommended.
return list;
}
int removeDuplicates()
void sort(Qt::CaseSensitivity cs)

Reimplemented in CalibrateCommand, DsoCommand, FlashLedCommand, InfoCommand, LoggerStartCommand, MeterCommand, ScanCommand, SetNameCommand, SetTorchCommand, and StatusCommand.

Definition at line 84 of file abstractcommand.cpp.

85{
86 return requiredOptions(parser) + QStringList{
87 QLatin1String("debug"),
88 QLatin1String("device"), QLatin1String("d"),
89 QLatin1String("output"),
90 QLatin1String("timeout"),
91 };
92}

References requiredOptions().

Referenced by processOptions(), CalibrateCommand::supportedOptions(), DsoCommand::supportedOptions(), FlashLedCommand::supportedOptions(), InfoCommand::supportedOptions(), LoggerStartCommand::supportedOptions(), MeterCommand::supportedOptions(), ScanCommand::supportedOptions(), SetNameCommand::supportedOptions(), SetTorchCommand::supportedOptions(), and StatusCommand::supportedOptions().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ TestAbstractCommand

friend class TestAbstractCommand
friend

Definition at line 50 of file abstractcommand.h.

Member Data Documentation

◆ deviceToScanFor

QString AbstractCommand::deviceToScanFor
protected

◆ discoveryAgent

PokitDiscoveryAgent* AbstractCommand::discoveryAgent
protected

◆ format


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