Dokit
dev
v0.6.0
v0.5.8
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.0
v0.3.0
v0.2.0
v0.1.2
v0.1.1
v0.1.0
User docs
Internal
Coverage
Internal development documentation
Toggle main menu visibility
Loading...
Searching...
No Matches
statuscommand.h
1
// SPDX-FileCopyrightText: 2022-2026 Paul Colby <git@colby.id.au>
2
// SPDX-License-Identifier: LGPL-3.0-or-later
3
4
#include "devicecommand.h"
5
6
#include <
qtpokit/statusservice.h
>
7
8
class
StatusCommand
:
public
DeviceCommand
9
{
10
Q_OBJECT
11
12
public
:
13
explicit
StatusCommand
(
QObject
*
const
parent
=
nullptr
);
14
15
QStringList
requiredOptions
(
const
QCommandLineParser
&parser)
const override
;
16
QStringList
supportedOptions
(
const
QCommandLineParser
&parser)
const override
;
17
18
public
slots:
19
QStringList
processOptions
(
const
QCommandLineParser
&parser)
override
;
20
21
protected
:
22
AbstractPokitService
*
getService
()
override
;
23
24
protected
slots:
25
void
serviceDetailsDiscovered
()
override
;
26
27
private
:
28
StatusService
*
service
{
nullptr
};
///< Bluetooth service this command interacts with.
29
30
void
outputDeviceStatus
(
const
StatusService::DeviceCharacteristics
&chrs);
31
32
QTPOKIT_BEFRIEND_TEST
(
StatusCommand
)
33
};
AbstractPokitService
The AbstractPokitService class provides a common base for Pokit services classes.
Definition
abstractpokitservice.h:27
DeviceCommand::DeviceCommand
DeviceCommand(QObject *const parent=nullptr)
Construct a new DeviceCommand object with parent.
Definition
devicecommand.cpp:21
StatusCommand
The StatusCommand class implements the status CLI command.
Definition
statuscommand.h:9
StatusCommand::supportedOptions
QStringList supportedOptions(const QCommandLineParser &parser) const override
Returns a list of CLI option names supported by this command.
Definition
statuscommand.cpp:36
StatusCommand::requiredOptions
QStringList requiredOptions(const QCommandLineParser &parser) const override
Returns a list of CLI option names required by this command.
Definition
statuscommand.cpp:30
StatusCommand::processOptions
QStringList processOptions(const QCommandLineParser &parser) override
Processes the relevant options from the command line parser.
Definition
statuscommand.cpp:47
StatusCommand::service
StatusService * service
Bluetooth service this command interacts with.
Definition
statuscommand.h:28
StatusCommand::StatusCommand
StatusCommand(QObject *const parent=nullptr)
Construct a new StatusCommand object with parent.
Definition
statuscommand.cpp:25
StatusCommand::getService
AbstractPokitService * getService() override
Returns a Pokit service object for the derived command class.
Definition
statuscommand.cpp:62
StatusCommand::outputDeviceStatus
void outputDeviceStatus(const StatusService::DeviceCharacteristics &chrs)
Outputs the Pokit device's details, including chrs, in the selected format.
Definition
statuscommand.cpp:92
StatusCommand::serviceDetailsDiscovered
void serviceDetailsDiscovered() override
Handles service detail discovery events.
Definition
statuscommand.cpp:77
StatusService
The StatusService class accesses the Pokit Status service of Pokit devices.
Definition
statusservice.h:23
QCommandLineParser
QObject::QObject
QObject(QObject *parent)
QObject::Q_OBJECT
Q_OBJECTQ_OBJECT
QObject::parent
QObject * parent() const const
QStringList
QTPOKIT_BEFRIEND_TEST
#define QTPOKIT_BEFRIEND_TEST(Class)
Macro for befriending a related unit test class, but only when QT_TESTLIB_LIB is defined.
Definition
qtpokit_global.h:118
statusservice.h
Declares the StatusService class.
StatusService::DeviceCharacteristics
Attributes included in the Device Characteristics characteristic.
Definition
statusservice.h:67
dokit
dokit
src
cli
statuscommand.h
Generated by
1.18.0