wlan_bearer/wlanldd/wlan_common/umac_common/inc/umacscanfsmcntx.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2005-2007 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 the License "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:   Declaration of the WlanScanFsmCntx class.
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 6 %
       
    20 */
       
    21 
       
    22 #ifndef C_WLANSCANFSMCNTX_H
       
    23 #define C_WLANSCANFSMCNTX_H
       
    24 
       
    25 #include "umacscanmoderunning.h"
       
    26 #include "umacscanmodestopped.h"
       
    27 #include "umacstartscanningmode.h"
       
    28 #include "umacstopscanningmode.h"
       
    29 
       
    30 class TWlanScanFsm;
       
    31 class MWlanScanFsmCb;
       
    32 
       
    33 /**
       
    34  *  Scan statemachine context.
       
    35  *
       
    36  *  @lib wlanumac.lib
       
    37  *  @since S60 v3.1
       
    38  */
       
    39 class WlanScanFsmCntx 
       
    40     {
       
    41 
       
    42     friend class TWlanScanFsm;
       
    43     friend class TWlanScanModeRunning;
       
    44     friend class TWlanScanModeStopped;
       
    45     friend class TWlanStartScanningMode;
       
    46     friend class TWlanStopScanningMode;
       
    47 
       
    48 public:
       
    49     
       
    50     
       
    51     inline explicit WlanScanFsmCntx( MWlanScanFsmCb& aCb );
       
    52 
       
    53     /**
       
    54      * ?description
       
    55      *
       
    56      * @since S60 3.1
       
    57      * @return ?description
       
    58      */
       
    59     inline TWlanScanFsm& Current();
       
    60 
       
    61 private:
       
    62 
       
    63     /**
       
    64      * ?description
       
    65      *
       
    66      * @since S60 3.1
       
    67      * @param ?arg1 ?description
       
    68      * @param ?arg2 ?description
       
    69      * @return ?description
       
    70      */
       
    71     inline void Current( TWlanScanFsm& aNewCurrent );
       
    72 
       
    73     /**
       
    74      * ?description
       
    75      *
       
    76      * @since S60 3.1
       
    77      * @return ?description
       
    78      */
       
    79     inline MWlanScanFsmCb& Cb();
       
    80 
       
    81     /**
       
    82      * ?description
       
    83      *
       
    84      * @since S60 3.1
       
    85      * @return ?description
       
    86      */
       
    87     inline TWlanScanFsm& ScanModeRunning();
       
    88 
       
    89     /**
       
    90      * ?description
       
    91      *
       
    92      * @since S60 3.1
       
    93      * @return ?description
       
    94      */
       
    95     inline TWlanScanFsm& ScanModeStopped();
       
    96 
       
    97     /**
       
    98      * ?description
       
    99      *
       
   100      * @since S60 3.1
       
   101      * @return ?description
       
   102      */
       
   103     inline TWlanScanFsm& StartScanningMode();
       
   104 
       
   105     /**
       
   106      * ?description
       
   107      *
       
   108      * @since S60 3.1
       
   109      * @return ?description
       
   110      */
       
   111     inline TWlanScanFsm& StopScanningMode();
       
   112 
       
   113     // Prohibit copy constructor
       
   114     WlanScanFsmCntx( const WlanScanFsmCntx& );
       
   115     // Prohibit assigment operator
       
   116     WlanScanFsmCntx& operator= ( const WlanScanFsmCntx& );    
       
   117 
       
   118 private: // data
       
   119 
       
   120     /**
       
   121      * ?description_of_member
       
   122      */
       
   123     MWlanScanFsmCb&         iCb;
       
   124 
       
   125     /**
       
   126      * ?description_of_member
       
   127      */
       
   128     TWlanScanModeRunning    iWlanScanModeRunning;
       
   129 
       
   130     /**
       
   131      * ?description_of_member
       
   132      */
       
   133     TWlanScanModeStopped    iWlanScanModeStopped;
       
   134 
       
   135     /**
       
   136      * ?description_of_member
       
   137      */
       
   138     TWlanStartScanningMode  iWlanStartScanningMode;
       
   139 
       
   140     /**
       
   141      * ?description_of_member
       
   142      */
       
   143     TWlanStopScanningMode   iWlanStopScanningMode;  
       
   144 
       
   145     /**
       
   146      * ?description_of_pointer_member
       
   147      * Own.  
       
   148      */
       
   149     TWlanScanFsm*           iCurrentState;
       
   150 
       
   151     };
       
   152 
       
   153 #include "umacscanfsmcntx.inl"
       
   154 
       
   155 #endif // C_WLANSCANFSMCNTX_H