coreapplicationuis/rfsplugins/tsrc/rfspluginstest/CertRFSPluginTestModule/inc/CertRFSPluginTestModule.h
changeset 69 dcd4152cfe55
equal deleted inserted replaced
65:8a530a83576a 69:dcd4152cfe55
       
     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 CERTRFSPLUGINTESTMODULE_H
       
    19 #define CERTRFSPLUGINTESTMODULE_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( KCertRFSPluginTestModuleLogPath, "\\logs\\testframework\\CertRFSPluginTestModule\\" ); 
       
    38 // Log file
       
    39 _LIT( KCertRFSPluginTestModuleLogFile, "CertRFSPluginTestModule.txt" ); 
       
    40 _LIT( KCertRFSPluginTestModuleLogFileWithTitle, "CertRFSPluginTestModule_[%S].txt" );
       
    41 
       
    42 // FUNCTION PROTOTYPES
       
    43 //?type ?function_name(?arg_list);
       
    44 
       
    45 
       
    46 // FORWARD DECLARATIONS
       
    47 //class ?FORWARD_CLASSNAME;
       
    48 class CRFSPlugin;
       
    49 class CCertRFSPluginTestModule;
       
    50 
       
    51 // DATA TYPES
       
    52 //enum ?declaration
       
    53 //typedef ?declaration
       
    54 //extern ?data_type;
       
    55 
       
    56 // CLASS DECLARATION
       
    57 
       
    58 /**
       
    59 *  CCertRFSPluginTestModule test class for STIF Test Framework TestScripter.
       
    60 *  ?other_description_lines
       
    61 *
       
    62 *  @lib ?library
       
    63 *  @since ?Series60_version
       
    64 */
       
    65 NONSHARABLE_CLASS(CCertRFSPluginTestModule) : public CScriptBase
       
    66     {
       
    67     public:  // Constructors and destructor
       
    68 
       
    69         /**
       
    70         * Two-phased constructor.
       
    71         */
       
    72         static CCertRFSPluginTestModule* NewL( CTestModuleIf& aTestModuleIf );
       
    73 
       
    74         /**
       
    75         * Destructor.
       
    76         */
       
    77         virtual ~CCertRFSPluginTestModule();
       
    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         /**
       
   102         * ?member_description.
       
   103         * @since ?Series60_version
       
   104         * @param ?arg1 ?description
       
   105         * @return ?description
       
   106         */
       
   107         //?type ?member_function( ?type ?arg1 );
       
   108 
       
   109     protected:  // Functions from base classes
       
   110 
       
   111         /**
       
   112         * From ?base_class ?member_description
       
   113         */
       
   114         //?type ?member_function();
       
   115 
       
   116     private:
       
   117 
       
   118         /**
       
   119         * C++ default constructor.
       
   120         */
       
   121         CCertRFSPluginTestModule( CTestModuleIf& aTestModuleIf );
       
   122 
       
   123         /**
       
   124         * By default Symbian 2nd phase constructor is private.
       
   125         */
       
   126         void ConstructL();
       
   127 
       
   128         // Prohibit copy constructor if not deriving from CBase.
       
   129         // ?classname( const ?classname& );
       
   130         // Prohibit assigment operator if not deriving from CBase.
       
   131         // ?classname& operator=( const ?classname& );
       
   132 
       
   133         /**
       
   134         * Frees all resources allocated from test methods.
       
   135         * @since ?Series60_version
       
   136         */
       
   137         void Delete();
       
   138 
       
   139     
       
   140         /**
       
   141          * Method used to log version of test class
       
   142          */
       
   143         void SendTestClassVersion();
       
   144 
       
   145         /**
       
   146         * Test methods are listed below. 
       
   147         */
       
   148         TInt CreatePlugin( CStifItemParser& aItem );
       
   149         TInt DestroyPlugin( CStifItemParser& aItem );
       
   150         TInt RestoreFactorySettings( CStifItemParser& aItem );
       
   151         TInt GetScript( CStifItemParser& aItem );
       
   152         TInt ExecuteCustomCommand( CStifItemParser& aItem );
       
   153         // Add new test methods here
       
   154 
       
   155     public:     // Data
       
   156         // ?one_line_short_description_of_data
       
   157         //?data_declaration;
       
   158 
       
   159     protected:  // Data
       
   160         // ?one_line_short_description_of_data
       
   161         //?data_declaration;
       
   162 
       
   163     private:    // Data
       
   164         CRFSPlugin* iPlugin;
       
   165         // ?one_line_short_description_of_data
       
   166         //?data_declaration;
       
   167 
       
   168         // Reserved pointer for future extension
       
   169         //TAny* iReserved;
       
   170 
       
   171     public:     // Friend classes
       
   172         //?friend_class_declaration;
       
   173     protected:  // Friend classes
       
   174         //?friend_class_declaration;
       
   175     private:    // Friend classes
       
   176         //?friend_class_declaration;
       
   177 
       
   178     };
       
   179 
       
   180 #endif      // CERTRFSPLUGINTESTMODULE_H
       
   181 
       
   182 // End of File