os/ossrv/stdcpp/tsrc/BC/apps/BCCppWrap/inc/BCCppWrap.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     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:       
    15 *
    16 */
    17 
    18 
    19 #ifndef BCCPPWRAP_H
    20 #define BCCPPWRAP_H
    21 
    22 //  INCLUDES
    23 #include <StifLogger.h>
    24 #include <TestScripterInternal.h>
    25 #include <StifTestModule.h>
    26 
    27 
    28 // CONSTANTS
    29 //const ?type ?constant_var = ?constant;
    30 
    31 // MACROS
    32 //#define ?macro ?macro_def
    33 #define TEST_CLASS_VERSION_MAJOR 50
    34 #define TEST_CLASS_VERSION_MINOR 9
    35 #define TEST_CLASS_VERSION_BUILD 06
    36 
    37 // Logging path
    38 _LIT( KBCCppWrapLogPath, "\\logs\\testframework\\BCCppWrap\\" ); 
    39 // Log file
    40 _LIT( KBCCppWrapLogFile, "BCCppWrap.txt" ); 
    41 _LIT( KBCCppWrapLogFileWithTitle, "BCCppWrap_[%S].txt" );
    42 
    43 // FUNCTION PROTOTYPES
    44 //?type ?function_name(?arg_list);
    45 
    46 // FORWARD DECLARATIONS
    47 //class ?FORWARD_CLASSNAME;
    48 class CBCCppWrap;
    49 
    50 // DATA TYPES
    51 //enum ?declaration
    52 //typedef ?declaration
    53 //extern ?data_type;
    54 
    55 // CLASS DECLARATION
    56 
    57 /**
    58 *  CBCCppWrap test class for STIF Test Framework TestScripter.
    59 *  ?other_description_lines
    60 *
    61 *  @lib ?library
    62 *  @since ?Series60_version
    63 */
    64 NONSHARABLE_CLASS(CBCCppWrap) : public CScriptBase
    65     {
    66     public:  // Constructors and destructor
    67 
    68         /**
    69         * Two-phased constructor.
    70         */
    71         static CBCCppWrap* NewL( CTestModuleIf& aTestModuleIf );
    72 
    73         /**
    74         * Destructor.
    75         */
    76         virtual ~CBCCppWrap();
    77 
    78     public: // New functions
    79 
    80         /**
    81         * ?member_description.
    82         * @since ?Series60_version
    83         * @param ?arg1 ?description
    84         * @return ?description
    85         */
    86         //?type ?member_function( ?type ?arg1 );
    87 
    88     public: // Functions from base classes
    89 
    90         /**
    91         * From CScriptBase Runs a script line.
    92         * @since ?Series60_version
    93         * @param aItem Script line containing method name and parameters
    94         * @return Symbian OS error code
    95         */
    96         virtual TInt RunMethodL( CStifItemParser& aItem );
    97 
    98     protected:  // New functions
    99 
   100         /**
   101         * ?member_description.
   102         * @since ?Series60_version
   103         * @param ?arg1 ?description
   104         * @return ?description
   105         */
   106         //?type ?member_function( ?type ?arg1 );
   107 
   108     protected:  // Functions from base classes
   109 
   110         /**
   111         * From ?base_class ?member_description
   112         */
   113         //?type ?member_function();
   114 
   115     private:
   116 
   117         /**
   118         * C++ default constructor.
   119         */
   120         CBCCppWrap( CTestModuleIf& aTestModuleIf );
   121 
   122         /**
   123         * By default Symbian 2nd phase constructor is private.
   124         */
   125         void ConstructL();
   126 
   127         // Prohibit copy constructor if not deriving from CBase.
   128         // ?classname( const ?classname& );
   129         // Prohibit assigment operator if not deriving from CBase.
   130         // ?classname& operator=( const ?classname& );
   131 
   132         /**
   133         * Frees all resources allocated from test methods.
   134         * @since ?Series60_version
   135         */
   136         void Delete();
   137 
   138         /**
   139         * Test methods are listed below. 
   140         */
   141 
   142         /**
   143         * Example test method.
   144         * @since ?Series60_version
   145         * @param aItem Script line containing parameters.
   146         * @return Symbian OS error code.
   147         */
   148         virtual TInt TestAPI( CStifItemParser& aItem );
   149         
   150         /**
   151          * Method used to log version of test class
   152          */
   153         void SendTestClassVersion();
   154 
   155         //ADD NEW METHOD DEC HERE
   156         //[TestMethods] - Do not remove
   157 
   158     public:     // Data
   159         // ?one_line_short_description_of_data
   160         //?data_declaration;
   161 
   162     protected:  // Data
   163         // ?one_line_short_description_of_data
   164         //?data_declaration;
   165 
   166     private:    // Data
   167         
   168         // ?one_line_short_description_of_data
   169         //?data_declaration;
   170 
   171         // Reserved pointer for future extension
   172         //TAny* iReserved;
   173 
   174     public:     // Friend classes
   175         //?friend_class_declaration;
   176     protected:  // Friend classes
   177         //?friend_class_declaration;
   178     private:    // Friend classes
   179         //?friend_class_declaration;
   180 
   181     };
   182 
   183 #endif      // BCCPPWRAP_H
   184 
   185 // End of File