QWlanManager
Loading...
Searching...
No Matches
qwm::Network Class Reference

Class containing network properties. More...

Public Member Functions

 Network (const Network &other)
 
 Network (Network &&other)
 
bool isValid () const
 Allow to know if a network instance is valid.
 
const QString & getSsid () const
 Retrieve network SSID.
 
const QString & getProfileName () const
 Retrieve network profile name.
 
AuthAlgo getAuthAlgo () const
 Retrieve network authentication algorithm.
 
CipherAlgo getCipherAlgo () const
 Retrieve network cipher algorithm.
 
uint getSignalQuality () const
 Retrieve network signal quality.
 
Networkoperator= (const Network &other)
 
Networkoperator= (Network &&other)
 
bool operator== (const Network &other) const
 Use to compare network instances.
 
bool operator!= (const Network &other) const
 

Properties

QString ssid
 
QString profile
 
AuthAlgo authAlgo
 
CipherAlgo cipherAlgo
 
uint signalQuality
 

Friends

class NetworkMutator
 

Detailed Description

Class containing network properties.

This class contains all related network properties (ssid, authentication algo, signal quality, etc...).
This class use implicit sharing memory (via shared pointer), this allow to:

  • Always have a network object with "last" known properties without having to fetch them from qwm::Interface
  • When setting properties, they are propagated to all instances
  • Passing this class by value is cheap This class is also compatible with QML.
See also
qwm::Manager, qwm::Interface

Member Function Documentation

◆ isValid()

bool qwm::Network::isValid ( ) const

Allow to know if a network instance is valid.

Returns
Returns true if network is valid

◆ getSsid()

const QString & qwm::Network::getSsid ( ) const

Retrieve network SSID.

Returns
Returns SSID of network

◆ getProfileName()

const QString & qwm::Network::getProfileName ( ) const

Retrieve network profile name.

Returns
Returns profile name of network

◆ getAuthAlgo()

AuthAlgo qwm::Network::getAuthAlgo ( ) const

Retrieve network authentication algorithm.

Returns
Returns authentication algorithm of network

◆ getCipherAlgo()

CipherAlgo qwm::Network::getCipherAlgo ( ) const

Retrieve network cipher algorithm.

Returns
Returns cipher algorithm of network

◆ getSignalQuality()

uint qwm::Network::getSignalQuality ( ) const

Retrieve network signal quality.

Returns
Returns signal quality of network in percent.

◆ operator==()

bool qwm::Network::operator== ( const Network & other) const

Use to compare network instances.

Networks are considered equals if ssid and authentication/cipher algorithms are equals or if both are invalid.

Parameters
[in]otherOther network to compare
Returns
Returns true if equals.

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