ModemManagerQt

modemsignal.h
1/*
2 SPDX-FileCopyrightText: 2014 Lukas Tinkl <ltinkl@redhat.com>
3 SPDX-FileCopyrightText: 2015 Jan Grulich <jgrulich@redhat.com>
4
5 SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
6*/
7
8#ifndef MODEMMANAGERQT_MODEMSIGNAL_H
9#define MODEMMANAGERQT_MODEMSIGNAL_H
10
11#include "interface.h"
12#include <modemmanagerqt_export.h>
13
14#include <QDBusPendingReply>
15#include <QObject>
16#include <QSharedPointer>
17
18namespace ModemManager
19{
20class ModemSignalPrivate;
21
22/**
23 * @brief The ModemSignal class
24 *
25 * This class provides access to extended signal quality information.
26 *
27 * @since 1.1.94
28 */
29class MODEMMANAGERQT_EXPORT ModemSignal : public Interface
30{
32 Q_DECLARE_PRIVATE(ModemSignal)
33
34public:
36 typedef QList<Ptr> List;
37
38 explicit ModemSignal(const QString &path, QObject *parent = nullptr);
39 ~ModemSignal() override;
40
41 /**
42 * @return refresh rate for the extended signal quality information updates, in seconds.
43 * A value of 0 disables the retrieval of the values.
44 */
45 uint rate() const;
46
47 /**
48 * @return Dictionary of available signal information for the CDMA1x access technology.
49 *
50 * This dictionary is composed of a string key, with an associated data which contains type-specific information.
51 * @param rssi The CDMA1x RSSI (Received Signal Strength Indication), in dBm, given as a floating point value (signature "d").
52 * @param ecio The CDMA1x Ec/Io, in dBm, given as a floating point value (signature "d").
53 */
54 QVariantMap cdma() const;
55
56 /**
57 * @return Dictionary of available signal information for the CDMA EV-DO access technology.
58 *
59 * This dictionary is composed of a string key, with an associated data which contains type-specific information.
60 * @param rssi The CDMA EV-DO RSSI (Received Signal Strength Indication), in dBm, given as a floating point value (signature "d").
61 * @param ecio The CDMA EV-DO Ec/Io, in dBm, given as a floating point value (signature "d").
62 * @param sinr CDMA EV-DO SINR level, in dB, given as a floating point value (signature "d").
63 * @param io The CDMA EV-DO Io, in dBm, given as a floating point value (signature "d").
64 */
65 QVariantMap evdo() const;
66
67 /**
68 * @return Dictionary of available signal information for the GSM/GPRS access technology.
69 *
70 * This dictionary is composed of a string key, with an associated data which contains type-specific information.
71 * @param rssi The GSM RSSI (Received Signal Strength Indication), in dBm, given as a floating point value (signature "d").
72 */
73 QVariantMap gsm() const;
74
75 /**
76 * @return Dictionary of available signal information for the UMTS (WCDMA) access technology.
77 *
78 * This dictionary is composed of a string key, with an associated data which contains type-specific information.
79 * @param rssi The LTE RSSI (Received Signal Strength Indication), in dBm, given as a floating point value (signature "d").
80 * @param rsrq The LTE RSRQ (Reference Signal Received Quality), in dB, given as a floating point value (signature "d").
81 * @param rsrp The LTE RSRP (Reference Signal Received Power), in dBm, given as a floating point value (signature "d").
82 * @param snr The LTE S/R ratio, in dB, given as a floating point value (signature "d").
83 */
84 QVariantMap lte() const;
85
86 /**
87 * @return Dictionary of available signal information for the UMTS (WCDMA) access technology.
88 *
89 * This dictionary is composed of a string key, with an associated data which contains type-specific information.
90 * @param rssi The UMTS RSSI (Received Signal Strength Indication), in dBm, given as a floating point value (signature "d").
91 * @param ecio The UMTS Ec/Io, in dBm, given as a floating point value (signature "d").
92 */
93 QVariantMap umts() const;
94
95 /**
96 * Setup extended signal quality information retrieval.
97 * @param rate refresh rate to set, in seconds. 0 to disable retrieval.
98 */
100
101 /**
102 * Sets the timeout in milliseconds for all async method DBus calls.
103 * -1 means the default DBus timeout (usually 25 seconds).
104 */
105 void setTimeout(int timeout);
106
107 /**
108 * Returns the current value of the DBus timeout in milliseconds.
109 * -1 means the default DBus timeout (usually 25 seconds).
110 */
111 int timeout() const;
112
114 void rateChanged(uint rate);
115 void cdmaChanged(const QVariantMap &cdma);
116 void evdoChanged(const QVariantMap &evdo);
117 void gsmChanged(const QVariantMap &gsm);
118 void umtsChanged(const QVariantMap &umts);
119 void lteChanged(const QString &lte);
120};
121
122} // namespace ModemManager
123
124#endif
QVariantMap gsm() const
QVariantMap cdma() const
QVariantMap umts() const
QVariantMap lte() const
QDBusPendingReply< void > setup(uint rate)
Setup extended signal quality information retrieval.
void setTimeout(int timeout)
Sets the timeout in milliseconds for all async method DBus calls.
QVariantMap evdo() const
int timeout() const
Returns the current value of the DBus timeout in milliseconds.
This namespace allows to query the underlying system to discover the available modem interfaces respo...
Definition bearer.cpp:20
QObject(QObject *parent)
Q_OBJECTQ_OBJECT
Q_SIGNALSQ_SIGNALS
QObject * parent() const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 24 2025 11:54:23 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.