stif/TestEngine/inc/STIFTestFrameworkSettings.h
branchRCL_3
changeset 59 8ad140f3dd41
parent 0 a03f92240627
equal deleted inserted replaced
49:7fdc9a71d314 59:8ad140f3dd41
       
     1 /*
       
     2 * Copyright (c) 2009 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: This file contains the header file of the 
       
    15 * CSTIFTestFrameworkSettings.
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef STIFTESTFRAMEWORKSETTINGS_H
       
    20 #define STIFTESTFRAMEWORKSETTINGS_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include <StifLogger.h>
       
    25 #include <StifParser.h>
       
    26 
       
    27 // CONSTANTS
       
    28 // None
       
    29 
       
    30 // MACROS
       
    31 // None
       
    32 
       
    33 // DATA TYPES
       
    34 // None
       
    35 
       
    36 // FUNCTION PROTOTYPES
       
    37 // None
       
    38 
       
    39 // FORWARD DECLARATIONS
       
    40 // None
       
    41 
       
    42 // CLASS DECLARATION
       
    43 
       
    44 // DESCRIPTION
       
    45 // CSTIFTestFrameworkSettings is a STIF Test Framework Test Engine class.
       
    46 // Class contains different operations of settings parsing from Test Framework
       
    47 // initíalization file.
       
    48 
       
    49 class CSTIFTestFrameworkSettings 
       
    50         :public CBase
       
    51     {
       
    52     public:     // Enumerations
       
    53 
       
    54     private:    // Enumerations
       
    55 
       
    56     public:     // Constructors and destructor
       
    57 
       
    58         /**
       
    59         * Two-phased constructor.
       
    60         */
       
    61         IMPORT_C static CSTIFTestFrameworkSettings* NewL();
       
    62 
       
    63         /**
       
    64         * Destructor.
       
    65         */
       
    66         IMPORT_C virtual ~CSTIFTestFrameworkSettings();
       
    67 
       
    68     public:     // New functions
       
    69 
       
    70         /**
       
    71         * Get report mode settings from STIF TestFramework's ini file.
       
    72         */
       
    73         IMPORT_C TInt GetReportModeL( CStifSectionParser* aSectionParser,
       
    74                                                 TPtrC aTag,
       
    75                                                 TUint& aSetting );
       
    76 
       
    77         /**
       
    78         * Get file settings from STIF TestFramework's ini file.
       
    79         */
       
    80         IMPORT_C TInt GetFileSetting( CStifSectionParser* aSectionParser,
       
    81                                                 TPtrC aTag,
       
    82                                                 TPtrC& aSetting );
       
    83 
       
    84         /**
       
    85         * Get format setting from STIF TestFramework's ini file.
       
    86         */
       
    87         IMPORT_C TInt GetFormatL( CStifSectionParser* aSectionParser,
       
    88                                         TPtrC aTag,
       
    89                                         CStifLogger::TLoggerType& aLoggerType );
       
    90 
       
    91         /**
       
    92         * Get output setting from STIF TestFramework's ini file.
       
    93         */
       
    94         IMPORT_C TInt GetOutputL( CStifSectionParser* aSectionParser,
       
    95                                         TPtrC aTag,
       
    96                                         CStifLogger::TOutput& aOutput );
       
    97 
       
    98         /**
       
    99         * Get boolean type of settings from STIF TestFramework's ini file.
       
   100         */
       
   101         IMPORT_C TInt GetBooleanSettingsL( CStifSectionParser* aSectionParser,
       
   102                                             TPtrC aTag,
       
   103                                             TBool& aOverwrite );
       
   104 
       
   105         /**
       
   106         * Get file creation mode setting from STIF TestFramework's ini file.
       
   107         */
       
   108         IMPORT_C TInt GetOverwriteL( CStifSectionParser* aSectionParser,
       
   109                                                 TPtrC aTag,
       
   110                                                 TBool& aOverwrite );
       
   111 
       
   112         /**
       
   113         * Get format setting from STIF TestFramework's ini file.
       
   114         */
       
   115         IMPORT_C TInt GetFormatL( CStifSectionParser* aSectionParser,
       
   116                                         TPtrC aTag,
       
   117                                         CStifLogger::TLoggerType& aLoggerType,
       
   118                                         TBool &aXML );
       
   119 
       
   120     public:     // Functions from base classes
       
   121 
       
   122     protected:  // New functions
       
   123 
       
   124     protected:  // Functions from base classes
       
   125 
       
   126     private:
       
   127 
       
   128         /**
       
   129         * C++ default constructor.
       
   130         */
       
   131         CSTIFTestFrameworkSettings();
       
   132 
       
   133         /**
       
   134         * By default Symbian OS constructor is private.
       
   135         */
       
   136         void ConstructL();
       
   137 
       
   138     public:     // Data
       
   139 
       
   140     protected:  // Data
       
   141 
       
   142     private:    // Data
       
   143 
       
   144     public:     // Friend classes
       
   145 
       
   146     protected:  // Friend classes
       
   147 
       
   148     private:    // Friend classes
       
   149 
       
   150     };
       
   151 
       
   152 #endif      // STIFTESTFRAMEWORKSETTINGS_H
       
   153 
       
   154 // End of File