devicediagnosticsfw/diagframework/inc/diagsuiteexecparam.h
branchRCL_3
changeset 25 b183ec05bd8c
parent 24 13d7c31c74e0
child 26 19bba8228ff0
equal deleted inserted replaced
24:13d7c31c74e0 25: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:  Provides execution parameters for Suite plug-ins
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef DIAGSUITEEXECPARAM_H
       
    21 #define DIAGSUITEEXECPARAM_H
       
    22 
       
    23 // SYSTEM INCLUDES
       
    24 #include <e32def.h>             // IMPORT_C / EXPORT_C
       
    25 
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 class MDiagSuiteObserver;
       
    29 class MDiagEngineCommon;
       
    30 
       
    31 /**
       
    32 * Diagnostics Suite plug-in Execution Parameters
       
    33 *
       
    34 * This class provides the execution environment for Suite plug-ins.
       
    35 *
       
    36 * @since S60 v5.0
       
    37 **/
       
    38 NONSHARABLE_CLASS( TDiagSuiteExecParam )
       
    39     {
       
    40 public:
       
    41     /**
       
    42     * C++ Constructor
       
    43     *
       
    44     * @param aObserver - Observer to notify continuation. 
       
    45     * @param aEngine - Reference to engine that provides necessary environment
       
    46     *   for suite execution, such as CDiagPluginPool, CAknViewAppUi and
       
    47     *   CDiagPluginExecPlan.
       
    48     */
       
    49     IMPORT_C TDiagSuiteExecParam( MDiagSuiteObserver& aObserver,
       
    50                                   MDiagEngineCommon& aEngine );
       
    51     
       
    52 public: // new functions
       
    53 
       
    54     /**
       
    55     * Get the Suite plug-in execution observer.
       
    56     *
       
    57     * @return MDiagSuiteObserver - Observer of Suite-plugin.
       
    58     **/
       
    59     IMPORT_C MDiagSuiteObserver& 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  - Suite execution observer.
       
    73     */
       
    74     MDiagSuiteObserver&  iObserver;
       
    75 
       
    76     /**
       
    77     * iEngine - Engine common interface.
       
    78     */
       
    79     MDiagEngineCommon&  iEngine;
       
    80     };
       
    81 
       
    82 #endif // DIAGSUITEEXECPARAM_H
       
    83 
       
    84 // End of File
       
    85