devicediagnosticsfw/diagframework/inc/diagexecplanentryimplobserver.h
branchRCL_3
changeset 61 b183ec05bd8c
parent 59 13d7c31c74e0
child 62 19bba8228ff0
equal deleted inserted replaced
59:13d7c31c74e0 61:b183ec05bd8c
     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 MDiagExecPlanEntryImplObserver.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGEXECPLANENTRYIMPLOBSERVER_H
       
    20 #define DIAGEXECPLANENTRYIMPLOBSERVER_H
       
    21 
       
    22 
       
    23 class CDiagExecPlanEntryImpl;
       
    24 
       
    25 /**
       
    26 * Diagnostics Plug-in Execution Plan Entry Observer Interface
       
    27 *
       
    28 * This interface is called by CDiagExecPlanEntryImpl and its derived classes
       
    29 * to notify progress of plugin execution.
       
    30 *
       
    31 * @since S60 v5.0
       
    32 *
       
    33 */
       
    34 class MDiagExecPlanEntryImplObserver
       
    35     {
       
    36 public:
       
    37     /**
       
    38     * Notify plugin execution progress
       
    39     * @param aSender        - Reference to the plan entry that caused this event.
       
    40     * @param aCurrentStep   - current execution step.
       
    41     * @param aTotalSteps    - Total number of steps to execute.
       
    42     */
       
    43     virtual void ExecPlanEntryProgressL( CDiagExecPlanEntryImpl& aSender,
       
    44                                          TUint aCurrentStep,
       
    45                                          TUint aTotalSteps ) = 0;
       
    46 
       
    47     /**
       
    48     * Notify plugin execution completion. 
       
    49     *   This is called only when it is completed normally.
       
    50     *   It will not becalled if execution is interrupted by watchdog or by client.
       
    51     * @param aSender        - Reference to the plan entry that caused this event.
       
    52     */
       
    53     virtual void ExecPlanEntryExecutedL( CDiagExecPlanEntryImpl& aSender ) = 0;
       
    54 
       
    55     /**
       
    56     * Notify that a critical error has occured.
       
    57     *   This is called when there is a critical execution error
       
    58     *   that cannot be recovered. Engine should not execute any
       
    59     *   more plug-ins after this point.
       
    60     * @param aError - Error number.
       
    61     */
       
    62     virtual void ExecPlanEntryCriticalError( TInt aError ) = 0;
       
    63     };
       
    64 
       
    65 #endif // DIAGEXECPLANENTRYIMPLOBSERVER_H
       
    66 
       
    67 // End of File
       
    68