wlanutilities/wlanqtutilities/base/inc/wlanqtutilswlanap.h
changeset 38 2dc6da6fb431
parent 29 dbe86d96ce5b
child 41 a87deff717bc
child 45 d9ec2b8c6bad
equal deleted inserted replaced
29:dbe86d96ce5b 38:2dc6da6fb431
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * This is the header file for WlanQtUtilsWlanAp class.
       
    16 */
       
    17 
       
    18 #ifndef WLANQTUTILSWLANAP_H
       
    19 #define WLANQTUTILSWLANAP_H
       
    20 
       
    21 #include <QObject>
       
    22 #include <QMetaType>
       
    23 #include "wlanqtutilscommon.h"
       
    24 
       
    25 class QString;
       
    26 
       
    27 /**
       
    28  * This class represents WLAN access point (AP).
       
    29  */
       
    30 class WLANQTUTILITIESDLL_EXPORT WlanQtUtilsWlanAp : public QObject
       
    31 {
       
    32 public:
       
    33 
       
    34     /**
       
    35      * Constructor.
       
    36      */
       
    37     WlanQtUtilsWlanAp();
       
    38 
       
    39     /**
       
    40      * Copy constructor.
       
    41      */
       
    42     WlanQtUtilsWlanAp(const WlanQtUtilsWlanAp &ref);
       
    43 
       
    44     /**
       
    45      * Constructor.
       
    46      * 
       
    47      * @param ssid SSID.
       
    48      * @param bssid BSSID, that is, MAC address.
       
    49      * @param signalStrength Signal strength.
       
    50      * @param connectionMode Connection mode as TConnMonNetworkMode.
       
    51      * @param securityMode WLAN Security mode.
       
    52      */
       
    53     WlanQtUtilsWlanAp(
       
    54         QString ssid,
       
    55         QString bssid,
       
    56         int signalStrength,
       
    57         int connectionMode,
       
    58         WlanQtUtilsWlanSecMode securityMode);
       
    59 
       
    60     /**
       
    61      * Destructor.
       
    62      */
       
    63     virtual ~WlanQtUtilsWlanAp();
       
    64 
       
    65     /**
       
    66      * Returns SSID.
       
    67      * 
       
    68      * @return SSID.
       
    69      */
       
    70     QString ssid() const;
       
    71 
       
    72     /**
       
    73      * Getter.
       
    74      * 
       
    75      * @return BSSID.
       
    76      */
       
    77     QString bssid() const;
       
    78 
       
    79     /**
       
    80      * Getter.
       
    81      * 
       
    82      * @return Signal strength.
       
    83      */
       
    84     int signalStrength() const;
       
    85 
       
    86     /**
       
    87      * Getter.
       
    88      * 
       
    89      * @return Connection mode as TConnMonNetworkMode.
       
    90      */
       
    91     int connectionMode() const;
       
    92 
       
    93     /**
       
    94      * Getter.
       
    95      * 
       
    96      * @return Security mode as WlanQtUtilsWlanSecMode.
       
    97      */
       
    98     WlanQtUtilsWlanSecMode securityMode() const;
       
    99 
       
   100     /**
       
   101      * Getter.
       
   102      * 
       
   103      * @return Security key.
       
   104      */
       
   105     QString securityKey() const;
       
   106 
       
   107     /**
       
   108      * Setter.
       
   109      * 
       
   110      * @param SSID.
       
   111      */
       
   112     void setSsid(QString ssid);
       
   113 
       
   114     /**
       
   115      * Setter.
       
   116      * 
       
   117      * @param BSSID.
       
   118      */
       
   119     void setBssid(QString bssid);
       
   120 
       
   121     /**
       
   122      * Setter.
       
   123      * 
       
   124      * @param Signal strength.
       
   125      */
       
   126     void setSignalStrength(int signalStrength);
       
   127 
       
   128     /**
       
   129      * Setter.
       
   130      * 
       
   131      * @param connectionMode Connection mode as TConnMonNetworkMode.
       
   132      */
       
   133     void setConnectionMode(int connectionMode);
       
   134 
       
   135     /**
       
   136      * Setter.
       
   137      * 
       
   138      * @param securityMode WLAN Security mode.
       
   139      */
       
   140     void setSecurityMode(WlanQtUtilsWlanSecMode securityMode);
       
   141 
       
   142     /**
       
   143      * Setter.
       
   144      * 
       
   145      * @param securityKey WLAN Security key.
       
   146      */
       
   147     void setSecurityKey(QString securityKey);
       
   148 
       
   149 private: //data
       
   150 
       
   151     /** SSID */
       
   152     QString ssid_;
       
   153     /** BSSID, that is, MAC address. */
       
   154     QString bssid_; // TODO: Check if QString is suitable
       
   155     /** Signal strength. */
       
   156     int signalStrength_;
       
   157     /** Connection mode as TConnMonNetworkMode. */
       
   158     int connectionMode_;
       
   159     /** WLAN security mode. */
       
   160     WlanQtUtilsWlanSecMode securityMode_;
       
   161     /** Security key, if available. */
       
   162     QString securityKey_;
       
   163 };
       
   164 
       
   165 Q_DECLARE_METATYPE(WlanQtUtilsWlanAp)
       
   166 
       
   167 #endif /* WLANQTUTILSWLANIAP_H */