devicediagnosticsfw/diagframework/inc/diagengineconfig.h
branchRCL_3
changeset 26 19bba8228ff0
parent 0 b497e44ab2fc
equal deleted inserted replaced
25:b183ec05bd8c 26:19bba8228ff0
       
     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 TDiagEngineConfig
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGENGINECONFIG_H
       
    20 #define DIAGENGINECONFIG_H
       
    21 
       
    22 // SYSTEM INCLUDE FILES
       
    23 #include <e32base.h>                // NONSHARABLE_CLASS
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CRepository;
       
    27 
       
    28 /**
       
    29 * Diagnostics Engine Configuration.
       
    30 *
       
    31 * This class implements TDiagEngineConfig class. This class stores configuration
       
    32 * information.
       
    33 *
       
    34 * @since S60 v5.0
       
    35 *
       
    36 */
       
    37 NONSHARABLE_CLASS( TDiagEngineConfig )
       
    38     {
       
    39 public:     // public interface
       
    40     /**
       
    41     * C++ default contructor
       
    42     */
       
    43     TDiagEngineConfig();
       
    44 
       
    45     /**
       
    46     * Read Cenrep key vaules
       
    47     */
       
    48     void ReadCenrepKeysL();
       
    49 
       
    50     /**
       
    51     * Get watchdog timeout vaule for interactive plug-ins.
       
    52     * 
       
    53     * @return Watchdog timeout value for interactive plug-ins. 
       
    54     */
       
    55     const TTimeIntervalMicroSeconds32& WatchdogTimeoutValueInteractive() const;
       
    56 
       
    57     /**
       
    58     * Get watchdog timeout vaule for automatic plug-ins.
       
    59     * 
       
    60     * @return Watchdog timeout value for automatic plug-ins. 
       
    61     */
       
    62     const TTimeIntervalMicroSeconds32& WatchdogTimeoutValueAutomatic() const;
       
    63 
       
    64     /**
       
    65     * Get test plug-in initial delay vaule.
       
    66     * 
       
    67     * @return Initial test plug-in delay vaule.
       
    68     *   Unit is in micro seconds
       
    69     */
       
    70     const TTimeIntervalMicroSeconds32& TestPluginInitialDelay() const;
       
    71 
       
    72     /**
       
    73     * Set whether engine is configured to disable dependency checks.
       
    74     *
       
    75     * @param aDisableDependency - ETrue to change configuration to disable
       
    76     *   dependency. EFalse to change configuration to enable dependency.
       
    77     */
       
    78     void SetDependencyDisabled( TBool aDisableDependency );
       
    79 
       
    80     /**
       
    81     * Get disable depndency value.
       
    82     *
       
    83     * @return - ETrue if dependency is disabled.
       
    84     *   EFalse if dependency is enabled.
       
    85     */
       
    86     TBool IsDependencyDisabled() const;
       
    87 
       
    88 private:    // private methods
       
    89     /**
       
    90     * Read TTimeIntervalMicroSeconds32 value from cenrep.
       
    91     *   
       
    92     * @param aCenrep - Reference to Cenrep object to read timeout value from.
       
    93     * @param aKey - Cenrep key to read.
       
    94     * @param aValue - If successful, this variable will be updated with
       
    95     *   the value from cenrep.
       
    96     */
       
    97     void ReadTimeIntervalFromCenrepL( CRepository& aCenrep,
       
    98                                       TUint32 aKey,
       
    99                                       TTimeIntervalMicroSeconds32& aValue );
       
   100 
       
   101 private:    // private data
       
   102     /**
       
   103     * iCenRepWatchdogTimeout - Watchdog timer value for Interactive steps.
       
   104     *   Unit is in microseconds.
       
   105     */
       
   106     TTimeIntervalMicroSeconds32 iCenRepWatchdogTimeoutInteractive;
       
   107     
       
   108     /**
       
   109     * iCenRepWatchdogTimeout - Watchdog timer value for automatic steps.
       
   110     *   Unit is in microseconds.
       
   111     */
       
   112     TTimeIntervalMicroSeconds32 iCenRepWatchdogTimeoutAutomatic;
       
   113 
       
   114     /**
       
   115     * iCenRepInitDelay - Initial delay for test plug-ins.
       
   116     *   Unit is in microseconds.
       
   117     */
       
   118     TTimeIntervalMicroSeconds32 iCenRepInitDelay;
       
   119 
       
   120     /**
       
   121     * iDisableDependency - If Enabled, dependency will not be executed.
       
   122     * From constructor input.
       
   123     */
       
   124     TBool iDisableDependency;
       
   125 
       
   126     };
       
   127 
       
   128 #endif // DIAGENGINECONFIG_H
       
   129 
       
   130 // End of File
       
   131