1 /*

     2 * Copyright (c) 2010 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: STIF testclass declaration

    15 *

    16 */

    17 

    18 #ifndef AIRFSPLUGINTESTMODULE_H

    19 #define AIRFSPLUGINTESTMODULE_H

    20 

    21 //  INCLUDES

    22 #include <StifLogger.h>

    23 #include <TestScripterInternal.h>

    24 #include <StifTestModule.h>

    25 #include <TestclassAssert.h>

    26 

    27 // CONSTANTS

    28 //const ?type ?constant_var = ?constant;

    29 

    30 // MACROS

    31 //#define ?macro ?macro_def

    32 #define TEST_CLASS_VERSION_MAJOR 0

    33 #define TEST_CLASS_VERSION_MINOR 0

    34 #define TEST_CLASS_VERSION_BUILD 0

    35 

    36 // Logging path

    37 _LIT( KAIRFSPluginTestModuleLogPath, "\\logs\\testframework\\AIRFSPluginTestModule\\" ); 

    38 // Log file

    39 _LIT( KAIRFSPluginTestModuleLogFile, "AIRFSPluginTestModule.txt" ); 

    40 _LIT( KAIRFSPluginTestModuleLogFileWithTitle, "AIRFSPluginTestModule_[%S].txt" );

    41 

    42 // FUNCTION PROTOTYPES

    43 //?type ?function_name(?arg_list);

    44 

    45 // FORWARD DECLARATIONS

    46 class CRFSPlugin;

    47 

    48 //class ?FORWARD_CLASSNAME;

    49 class CAIRFSPluginTestModule;

    50 

    51 // DATA TYPES

    52 //enum ?declaration

    53 //typedef ?declaration

    54 //extern ?data_type;

    55 

    56 // CLASS DECLARATION

    57 

    58 /**

    59 *  CAIRFSPluginTestModule test class for STIF Test Framework TestScripter.

    60 *  ?other_description_lines

    61 *

    62 *  @lib ?library

    63 *  @since ?Series60_version

    64 */

    65 NONSHARABLE_CLASS(CAIRFSPluginTestModule) : public CScriptBase

    66     {

    67     public:  // Constructors and destructor

    68 

    69         /**

    70         * Two-phased constructor.

    71         */

    72         static CAIRFSPluginTestModule* NewL( CTestModuleIf& aTestModuleIf );

    73 

    74         /**

    75         * Destructor.

    76         */

    77         virtual ~CAIRFSPluginTestModule();

    78 

    79     public: // New functions

    80 

    81         /**

    82         * ?member_description.

    83         * @since ?Series60_version

    84         * @param ?arg1 ?description

    85         * @return ?description

    86         */

    87         //?type ?member_function( ?type ?arg1 );

    88 

    89     public: // Functions from base classes

    90 

    91         /**

    92         * From CScriptBase Runs a script line.

    93         * @since ?Series60_version

    94         * @param aItem Script line containing method name and parameters

    95         * @return Symbian OS error code

    96         */

    97         virtual TInt RunMethodL( CStifItemParser& aItem );

    98 

    99     protected:  // New functions

   100 

   101         TInt CreatePlugin( CStifItemParser& aItem );

   102         TInt DestroyPlugin( CStifItemParser& aItem );

   103         TInt RestoreFactorySettings( CStifItemParser& aItem );

   104         TInt GetScript( CStifItemParser& aItem );

   105         TInt ExecuteCustomCommand( CStifItemParser& aItem );

   106 

   107     protected:  // Functions from base classes

   108 

   109         /**

   110         * From ?base_class ?member_description

   111         */

   112         //?type ?member_function();

   113 

   114     private:

   115 

   116         /**

   117         * C++ default constructor.

   118         */

   119         CAIRFSPluginTestModule( CTestModuleIf& aTestModuleIf );

   120 

   121         /**

   122         * By default Symbian 2nd phase constructor is private.

   123         */

   124         void ConstructL();

   125 

   126         // Prohibit copy constructor if not deriving from CBase.

   127         // ?classname( const ?classname& );

   128         // Prohibit assigment operator if not deriving from CBase.

   129         // ?classname& operator=( const ?classname& );

   130 

   131         /**

   132         * Frees all resources allocated from test methods.

   133         * @since ?Series60_version

   134         */

   135         void Delete();

   136 

   137         

   138         /**

   139          * Method used to log version of test class

   140          */

   141         void SendTestClassVersion();

   142 

   143         //ADD NEW METHOD DEC HERE

   144         //[TestMethods] - Do not remove

   145 

   146     public:     // Data

   147         // ?one_line_short_description_of_data

   148         //?data_declaration;

   149 

   150     protected:  // Data

   151         // ?one_line_short_description_of_data

   152         //?data_declaration;

   153 

   154     private:    // Data

   155         CRFSPlugin* iPlugin;

   156 

   157     public:     // Friend classes

   158         //?friend_class_declaration;

   159     protected:  // Friend classes

   160         //?friend_class_declaration;

   161     private:    // Friend classes

   162         //?friend_class_declaration;

   163 

   164     };

   165 

   166 #endif      // AIRFSPLUGINTESTMODULE_H

   167 

   168 // End of File