devicediagnosticsfw/diagframework/inc/diagengineeventtestprogress.h
branchRCL_3
changeset 26 19bba8228ff0
parent 0 b497e44ab2fc
equal deleted inserted replaced
25:b183ec05bd8c 26:19bba8228ff0
       
     1 /*
       
     2 * Copyright (c) 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 "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 declaration for DiagFwInternal::CEventTestProgress
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGENGINEEVENTTESTPROGRESS_H
       
    20 #define DIAGENGINEEVENTTESTPROGRESS_H
       
    21 
       
    22 // SYSTEM INCLUDES
       
    23 #include <e32base.h>            // CBase
       
    24 
       
    25 // USER INCLUDES
       
    26 #include "diagengineevents.h"       // DiagFwInternal::TEvent
       
    27 #include "diagengineeventbasic.h"   // DiagFwInternal::CEventBasic
       
    28 
       
    29 namespace DiagFwInternal
       
    30     {
       
    31 /**
       
    32 * CEventTestProgress
       
    33 *
       
    34 * Event for test progress
       
    35 */
       
    36 NONSHARABLE_CLASS( CEventTestProgress ) : public CEventBasic
       
    37     {
       
    38 public:
       
    39     /** 
       
    40     * C++ Constructor
       
    41     *
       
    42     * @param aSender - Sender of the progress event
       
    43     * @param aCurrentStep - Current progress step
       
    44     * @param aTotalSteps - Total number of steps to complete
       
    45     */
       
    46     CEventTestProgress( const MDiagPlugin& aSender, 
       
    47                         TUint aCurrentStep, 
       
    48                         TUint aTotalSteps );
       
    49 
       
    50     /** 
       
    51     * Get Sender
       
    52     *
       
    53     * @return Reference to the plugin
       
    54     */
       
    55     const MDiagPlugin& Sender() const;
       
    56 
       
    57     /** 
       
    58     * Get progress
       
    59     *
       
    60     * @return progress
       
    61     */
       
    62     TUint CurrStep() const;
       
    63 
       
    64     /** 
       
    65     * Get total number of steps to complete
       
    66     *
       
    67     * @return total number of steps
       
    68     */
       
    69     TUint TotalSteps() const;
       
    70 
       
    71 private:    // private data
       
    72     /**
       
    73     * iSender - Plug-in that sent in the progress
       
    74     */
       
    75     const MDiagPlugin& iSender;
       
    76 
       
    77     /**
       
    78     * iCurrStep - Current step.
       
    79     */
       
    80     TUint iCurrStep;
       
    81 
       
    82     /**
       
    83     * iTotalSteps - Total steps
       
    84     */
       
    85     TUint iTotalSteps;
       
    86     };
       
    87     } // namespace DiagFwInternal
       
    88 
       
    89 #endif // ifndef DIAGENGINEEVENTTESTPROGRESS_H
       
    90 
       
    91 // End of File
       
    92