ModemManager::Modem3gpp

Search for usage in LXR

ModemManager::Modem3gpp Class Reference

#include <modem3gpp.h>

Public Types

typedef QFlags< MMModem3gppFacility > FacilityLocks
 
typedef QList< PtrList
 
typedef QSharedPointer< Modem3gppPtr
 

Signals

void countryCodeChanged (const QString &countryCode)
 
void enabledFacilityLocksChanged (QFlags< MMModem3gppFacility > locks)
 
void imeiChanged (const QString &imei)
 
void operatorCodeChanged (const QString &operatorCode)
 
void operatorNameChanged (const QString &operatorName)
 
void registrationStateChanged (MMModem3gppRegistrationState registrationState)
 
void subscriptionStateChanged (MMModem3gppSubscriptionState subscriptionState)
 

Public Member Functions

 Modem3gpp (const QString &path, QObject *parent=nullptr)
 
QString countryCode () const
 
FacilityLocks enabledFacilityLocks () const
 
QString imei () const
 
QString operatorCode () const
 
QString operatorName () const
 
void registerToNetwork (const QString &networkId=QString())
 
MMModem3gppRegistrationState registrationState () const
 
QDBusPendingReply< QVariantMapListscan ()
 
void setTimeout (int timeout)
 
int timeout () const
 

Detailed Description

The Modem3gpp class.

This class provides access to specific actions that may be performed in modems with 3GPP capabilities.

Definition at line 31 of file modem3gpp.h.

Member Typedef Documentation

◆ FacilityLocks

Definition at line 41 of file modem3gpp.h.

◆ List

Definition at line 39 of file modem3gpp.h.

◆ Ptr

Constructor & Destructor Documentation

◆ Modem3gpp()

Modem3gpp::Modem3gpp ( const QString & path,
QObject * parent = nullptr )
explicit

Definition at line 49 of file modem3gpp.cpp.

◆ ~Modem3gpp()

Modem3gpp::~Modem3gpp ( )
override

Definition at line 76 of file modem3gpp.cpp.

Member Function Documentation

◆ countryCode()

QString Modem3gpp::countryCode ( ) const
Returns
country code of the operator to which the mobile is currently registered.

Returned in the format "ISO 3166-1 alpha-2" according to the MMC mapping from Wikipedia. Country Code is the two-letter country codes defined in ISO 3166-1, part of the ISO 3166 standard, e.g. "RU" or "FI".

If the MCC is not known or the mobile is not registered to a mobile network, this property will be an empty string.

Definition at line 104 of file modem3gpp.cpp.

◆ enabledFacilityLocks()

ModemManager::Modem3gpp::FacilityLocks Modem3gpp::enabledFacilityLocks ( ) const
Returns
QFlags of MMModem3gppFacility values for which PIN locking is enabled

Definition at line 110 of file modem3gpp.cpp.

◆ imei()

QString Modem3gpp::imei ( ) const
Returns
the IMEI of the device

Definition at line 80 of file modem3gpp.cpp.

◆ operatorCode()

QString Modem3gpp::operatorCode ( ) const
Returns
code of the operator to which the mobile is currently registered.

Returned in the format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile Country Code and MNC is the two- or three-digit GSM Mobile Network Code. e.g. e"31026" or "310260".

If the MCC and MNC are not known or the mobile is not registered to a mobile network, this property will be an empty string.

Definition at line 92 of file modem3gpp.cpp.

◆ operatorName()

QString Modem3gpp::operatorName ( ) const
Returns
name of the operator to which the mobile is currently registered.

If the operator name is not known or the mobile is not registered to a mobile network, this property will be an empty string.

Definition at line 98 of file modem3gpp.cpp.

◆ registerToNetwork()

void Modem3gpp::registerToNetwork ( const QString & networkId = QString())

Register the device to network.

Parameters
networkIdThe operator ID (ie, "MCCMNC", like "310260") to register. An empty string can be used to register to the home network.

Definition at line 124 of file modem3gpp.cpp.

◆ registrationState()

MMModem3gppRegistrationState Modem3gpp::registrationState ( ) const
Returns
mobile registration status as defined in 3GPP TS 27.007 section 10.1.19

Definition at line 86 of file modem3gpp.cpp.

◆ scan()

Scan for available networks.

Returns
a QList<QVariantMap> with the results, where each map may contain these values:

"status": A MMModem3gppNetworkAvailability value representing network availability status, given as an unsigned integer (signature "u"). This key will always be present.

"operator-long": Long-format name of operator, given as a string value (signature "s"). If the name is unknown, this field should not be present.

"operator-short": Short-format name of operator, given as a string value (signature "s"). If the name is unknown, this field should not be present.

"operator-code": Mobile code of the operator, given as a string value (signature "s"). Returned in the format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile Country Code and MNC is the two- or three-digit GSM Mobile Network Code. e.g. "31026" or "310260".

"access-technology": A MMModemAccessTechnology value representing the generic access technology used by this mobile network, given as an unsigned integer (signature "u").

Definition at line 130 of file modem3gpp.cpp.

◆ setTimeout()

void Modem3gpp::setTimeout ( int timeout)

Sets the timeout in milliseconds for all async method DBus calls.

-1 means the default DBus timeout (usually 25 seconds).

Definition at line 136 of file modem3gpp.cpp.

◆ timeout()

int Modem3gpp::timeout ( ) const

Returns the current value of the DBus timeout in milliseconds.

-1 means the default DBus timeout (usually 25 seconds).

Definition at line 142 of file modem3gpp.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:15:10 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.