devicediagnosticsfw/diagframework/inc/diagexecplanentry.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:  Class declaration for CDiagExecPlanEntry
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGEXECPLANENTRY_H
       
    20 #define DIAGEXECPLANENTRY_H
       
    21 
       
    22 
       
    23 // SYSTEM INCLUDE FILES
       
    24 #include <e32def.h>         // TBool
       
    25 
       
    26 // FORWARD DECLARATION
       
    27 class MDiagPlugin;
       
    28 
       
    29 /**
       
    30 * Diagnostics Plug-in Execution Plan Entry.
       
    31 *
       
    32 * This class provides the interface for test execution plan entries.
       
    33 *
       
    34 * @since S60 v5.0
       
    35 *
       
    36 */
       
    37 class MDiagExecPlanEntry
       
    38     {
       
    39 public: // data types
       
    40     /**
       
    41     * Item execution state.
       
    42     */
       
    43     enum TState
       
    44         {
       
    45         EStateQueued     = 0,   // Execution has not begun.
       
    46         EStateInitDelay,        // Waiting for initial delay timer to expire
       
    47         EStateRunning,          // RunTestL() is called. Waiting for completion.
       
    48         EStateSuspended,        // Execution is suspended
       
    49         EStateStopped,          // Plugin is stopped, but result not logged yet.
       
    50         EStateCompleted         // Result is logged
       
    51         };
       
    52 
       
    53 public:
       
    54     /**
       
    55     * Plugin associated with the entry
       
    56     *   @return Reference to the plugin.
       
    57     */
       
    58     virtual const MDiagPlugin& Plugin() const = 0;
       
    59 
       
    60     /**
       
    61     * Returns whether item is being executed to satisfy dependency or not.
       
    62     *   @return ETrue if item is being executed to satisfy dependency.
       
    63     *       EFalse if item is being executed explicitly.
       
    64     */
       
    65     virtual TBool AsDependency() const = 0;
       
    66 
       
    67     /**
       
    68     * Item State
       
    69     *   @return Current state of execution plan item
       
    70     */
       
    71     virtual TState State() const = 0;
       
    72 
       
    73     };
       
    74 
       
    75 #endif // DIAGEXECPLANENTRY_H
       
    76 
       
    77 // End of File
       
    78