remotemgmt_plat/diagnostics_plugin_api/inc/diagtestexecparam.h
changeset 32 5d0ec111abfc
parent 27 2c8580950a26
child 35 0deca9b72b62
equal deleted inserted replaced
27:2c8580950a26 32:5d0ec111abfc
     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:  Provides execution parameters for test plug-ins
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef DIAGTESTEXECPARAM_H
       
    21 #define DIAGTESTEXECPARAM_H
       
    22 
       
    23 
       
    24 // SYSTEM INCLUDES
       
    25 #include <e32def.h>             // IMPORT_C / EXPORT_C
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class MDiagTestObserver;
       
    29 class MDiagEngineCommon;
       
    30 
       
    31 /**
       
    32 * Diagnostics test plug-in Execution Parameters
       
    33 *
       
    34 * This class provides the execution environment for test plug-ins.
       
    35 *
       
    36 * @since S60 v5.0
       
    37 **/
       
    38 NONSHARABLE_CLASS( TDiagTestExecParam )
       
    39     {
       
    40 public: // constructor
       
    41     /**
       
    42     * C++ Constructor
       
    43     *
       
    44     * @param aObserver - Observer to notify test execution progress.
       
    45     * @param aEngine - Reference to engine that provides necessary environment
       
    46     *   for test execution, such as CDiagPluginPool, or CAknViewAppUi.
       
    47     */
       
    48     IMPORT_C TDiagTestExecParam( MDiagTestObserver& aObserver,
       
    49                                  MDiagEngineCommon& aEngine );
       
    50     
       
    51 public: // new functions
       
    52 
       
    53     /**
       
    54     * Get the test plug-in execution observer.
       
    55     *
       
    56     * @return MDiagTestObserver - Observer of test-plugin. Test progress
       
    57     *   and completion should be notified via this object.
       
    58     **/
       
    59     IMPORT_C MDiagTestObserver& Observer() const;
       
    60 
       
    61     /**
       
    62     * Get execution engine.
       
    63     *
       
    64     * @return MDiagEngineCommon - Engine that executes the plug-in.
       
    65     *   Engine provides various functionalities needed for executing
       
    66     *   plug-ins.
       
    67     **/
       
    68     IMPORT_C MDiagEngineCommon& Engine() const;
       
    69     
       
    70 private: // data
       
    71     /**
       
    72     * iObserver - Test execution observer.
       
    73     */
       
    74     MDiagTestObserver&  iObserver;
       
    75 
       
    76     /**
       
    77     * iEngine - Common Engine interface
       
    78     */
       
    79     MDiagEngineCommon&  iEngine;
       
    80     };
       
    81 
       
    82 #endif // DIAGTESTEXECPARAM_H
       
    83 
       
    84 // End of File
       
    85