devicediagnosticsfw/diagframework/inc/diagtestobserver.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:  Interface to observe test plug-ins
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGTESTOBSERVER_H
       
    20 #define DIAGTESTOBSERVER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32def.h>                         // TUint
       
    24 #include <DiagEngineWatchdogTypes.h>        // TDiagEngineWatchdogTypes
       
    25 
       
    26 // FORWARD DECLARATION
       
    27 class CDiagResultsDatabaseItem;
       
    28 class MDiagTestPlugin;
       
    29 
       
    30 
       
    31 /**
       
    32 * Diagnostics Framework Test Plug-in Observer
       
    33 *
       
    34 * This interface is called by Test Plug-ins to notify the engine
       
    35 * of its test execution progress or completion.
       
    36 *
       
    37 * @since S60 v3.2
       
    38 */
       
    39 class MDiagTestObserver
       
    40     {
       
    41 public:
       
    42     /**
       
    43     * Notify engine of test plug-in execution progress.
       
    44     *
       
    45     * @param aSender - Reference to sender object.
       
    46     * @param aCurrentStep - Current execution step.
       
    47     */
       
    48     virtual void TestProgressL( const MDiagTestPlugin& aSender, 
       
    49                                 TUint aCurrentStep ) = 0;
       
    50 
       
    51 
       
    52     /**
       
    53     * Notify engine of test plug-in execution completion.
       
    54     *
       
    55     * @param aSender       Reference to sender object.
       
    56     * @param aTestResult   Result of test execution. Ownership is transferred
       
    57     *                      from the plug-in to engine.
       
    58     */
       
    59     virtual void TestExecutionCompletedL( const MDiagTestPlugin& aSender, 
       
    60                                           CDiagResultsDatabaseItem* aTestResult ) = 0;
       
    61     };
       
    62 
       
    63 
       
    64 #endif // DIAGTESTOBSERVER_H
       
    65 
       
    66 // End of File
       
    67