wlanutilities/wlansniffer/mainapplication/inc/wsfactivetimeupdater.h
branchRCL_3
changeset 24 63be7eb3fc78
parent 23 b852595f5cbe
child 25 f28ada11abbf
equal deleted inserted replaced
23:b852595f5cbe 24:63be7eb3fc78
     1 /*
       
     2 * Copyright (c) 2007-2008 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:  Class header for CWsfActiveTimeUpdater
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef C_WSFACTIVETIMEUPDATER_H
       
    19 #define C_WSFACTIVETIMEUPDATER_H
       
    20 
       
    21 //  EXTERNAL INCLUDES
       
    22 #include <e32base.h>
       
    23 
       
    24 //  INTERNAL INCLUDES
       
    25 
       
    26 //  FORWARD DECLARATIONS
       
    27 class MWsfActiveTimerHandler;
       
    28 
       
    29 
       
    30 /**
       
    31  *  Responsible for time updating by using a customizable time interval.
       
    32  *  @since S60 v5.0
       
    33  */
       
    34 NONSHARABLE_CLASS( CWsfActiveTimeUpdater ) : public CBase
       
    35     {
       
    36     public:     // Constructors and destructor
       
    37         
       
    38         /**
       
    39          * Two-phased constructor
       
    40          * @since S60 5.0 
       
    41          * @param aActiveTimerHandler interface details views controller
       
    42          * @return instance of CWsfActiveTimeUpdater class
       
    43          */
       
    44         static CWsfActiveTimeUpdater* NewL(
       
    45                 MWsfActiveTimerHandler* aActiveTimerHandler );
       
    46 
       
    47 
       
    48         /**
       
    49          * Two-phased constructor. Leaves the object on CleanupStack
       
    50          * @since S60 5.0 
       
    51          * @param aActiveTimerHandler interface details views controller
       
    52          * @return instance of CWsfActiveTimeUpdater class
       
    53          */
       
    54         static CWsfActiveTimeUpdater* NewLC( 
       
    55                 MWsfActiveTimerHandler* aActiveTimerHandler );
       
    56         
       
    57         /**
       
    58          * Destructor of CWsfActiveTimeUpdater class
       
    59          * @since S60 5.0     
       
    60          */
       
    61         ~CWsfActiveTimeUpdater();
       
    62         
       
    63     private:    // Constructors
       
    64         
       
    65         /**
       
    66          * Default C++ constructor 
       
    67          * @since S60 5.0 
       
    68          * @param aActiveTimerHandler interface details views controller
       
    69          */
       
    70         CWsfActiveTimeUpdater( MWsfActiveTimerHandler* aActiveTimerHandler );
       
    71         
       
    72         /**
       
    73          * 2nd phase constructor
       
    74          * @since S60 5.0 
       
    75          */
       
    76         void ConstructL();
       
    77     
       
    78     public:     // New methods
       
    79     
       
    80         /**
       
    81          * Start update timer
       
    82          * @since S60 5.0 
       
    83          * @param aUpdateInterval refresh time interval
       
    84          */
       
    85         void Start( TInt aUpdateInterval );
       
    86         
       
    87         /**
       
    88          * Stop update timer
       
    89          * @since S60 5.0 
       
    90          */
       
    91         void Stop();
       
    92     
       
    93         /**
       
    94          * Called from static call back of CPeriodic.
       
    95          * The actual update process starts here
       
    96          * @since S60 5.0 
       
    97          */
       
    98         void DoUpdateTimeL();
       
    99         
       
   100     private:    // New methods
       
   101         /**
       
   102          * Function to called when periodic timer releases
       
   103          * @since S60 5.0 
       
   104          * @param aUpdater pointer to this
       
   105          */
       
   106         static TInt UpdateTimeL( TAny* aUpdater );
       
   107     
       
   108     private: 
       
   109     
       
   110         /**
       
   111          * Pointer to the Active Timer handler interface 
       
   112          * Own.
       
   113          */
       
   114         MWsfActiveTimerHandler* iActiveTimerHandler;
       
   115 
       
   116         /**
       
   117          * Timer, to refresh the details views
       
   118          * Own.
       
   119          */
       
   120         CPeriodic* iPeriodic;
       
   121     };
       
   122 
       
   123 #endif // C_WSFACTIVETIMEUPDATER_H