2
|
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: STIF testclass declaration
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
#ifndef TEMPLATESCRIPTXXX_H
|
|
19 |
#define TEMPLATESCRIPTXXX_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( KTemplateScriptXXXLogPath, "\\logs\\testframework\\TemplateScriptXXX\\" );
|
|
38 |
// Log file
|
|
39 |
_LIT( KTemplateScriptXXXLogFile, "TemplateScriptXXX.txt" );
|
|
40 |
_LIT( KTemplateScriptXXXLogFileWithTitle, "TemplateScriptXXX_[%S].txt" );
|
|
41 |
|
|
42 |
// FUNCTION PROTOTYPES
|
|
43 |
//?type ?function_name(?arg_list);
|
|
44 |
|
|
45 |
// FORWARD DECLARATIONS
|
|
46 |
//class ?FORWARD_CLASSNAME;
|
|
47 |
class CTemplateScriptXXX;
|
|
48 |
|
|
49 |
// DATA TYPES
|
|
50 |
//enum ?declaration
|
|
51 |
//typedef ?declaration
|
|
52 |
//extern ?data_type;
|
|
53 |
|
|
54 |
// CLASS DECLARATION
|
|
55 |
|
|
56 |
/**
|
|
57 |
* CTemplateScriptXXX test class for STIF Test Framework TestScripter.
|
|
58 |
* ?other_description_lines
|
|
59 |
*
|
|
60 |
* @lib ?library
|
|
61 |
* @since ?Series60_version
|
|
62 |
*/
|
|
63 |
NONSHARABLE_CLASS(CTemplateScriptXXX) : public CScriptBase
|
|
64 |
{
|
|
65 |
public: // Constructors and destructor
|
|
66 |
|
|
67 |
/**
|
|
68 |
* Two-phased constructor.
|
|
69 |
*/
|
|
70 |
static CTemplateScriptXXX* NewL( CTestModuleIf& aTestModuleIf );
|
|
71 |
|
|
72 |
/**
|
|
73 |
* Destructor.
|
|
74 |
*/
|
|
75 |
virtual ~CTemplateScriptXXX();
|
|
76 |
|
|
77 |
public: // New functions
|
|
78 |
|
|
79 |
/**
|
|
80 |
* ?member_description.
|
|
81 |
* @since ?Series60_version
|
|
82 |
* @param ?arg1 ?description
|
|
83 |
* @return ?description
|
|
84 |
*/
|
|
85 |
//?type ?member_function( ?type ?arg1 );
|
|
86 |
|
|
87 |
public: // Functions from base classes
|
|
88 |
|
|
89 |
/**
|
|
90 |
* From CScriptBase Runs a script line.
|
|
91 |
* @since ?Series60_version
|
|
92 |
* @param aItem Script line containing method name and parameters
|
|
93 |
* @return Symbian OS error code
|
|
94 |
*/
|
|
95 |
virtual TInt RunMethodL( CStifItemParser& aItem );
|
|
96 |
|
|
97 |
protected: // New functions
|
|
98 |
|
|
99 |
/**
|
|
100 |
* ?member_description.
|
|
101 |
* @since ?Series60_version
|
|
102 |
* @param ?arg1 ?description
|
|
103 |
* @return ?description
|
|
104 |
*/
|
|
105 |
//?type ?member_function( ?type ?arg1 );
|
|
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 |
CTemplateScriptXXX( 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 |
* Test methods are listed below.
|
|
139 |
*/
|
|
140 |
|
|
141 |
/**
|
|
142 |
* Example test method.
|
|
143 |
* @since ?Series60_version
|
|
144 |
* @param aItem Script line containing parameters.
|
|
145 |
* @return Symbian OS error code.
|
|
146 |
*/
|
|
147 |
virtual TInt ExampleL( CStifItemParser& aItem );
|
|
148 |
|
|
149 |
/**
|
|
150 |
* Method used to log version of test class
|
|
151 |
*/
|
|
152 |
void SendTestClassVersion();
|
|
153 |
|
|
154 |
//ADD NEW METHOD DEC HERE
|
|
155 |
//[TestMethods] - Do not remove
|
|
156 |
|
|
157 |
public: // Data
|
|
158 |
// ?one_line_short_description_of_data
|
|
159 |
//?data_declaration;
|
|
160 |
|
|
161 |
protected: // Data
|
|
162 |
// ?one_line_short_description_of_data
|
|
163 |
//?data_declaration;
|
|
164 |
|
|
165 |
private: // Data
|
|
166 |
|
|
167 |
// ?one_line_short_description_of_data
|
|
168 |
//?data_declaration;
|
|
169 |
|
|
170 |
// Reserved pointer for future extension
|
|
171 |
//TAny* iReserved;
|
|
172 |
|
|
173 |
public: // Friend classes
|
|
174 |
//?friend_class_declaration;
|
|
175 |
protected: // Friend classes
|
|
176 |
//?friend_class_declaration;
|
|
177 |
private: // Friend classes
|
|
178 |
//?friend_class_declaration;
|
|
179 |
|
|
180 |
};
|
|
181 |
|
|
182 |
#endif // TEMPLATESCRIPTXXX_H
|
|
183 |
|
|
184 |
// End of File
|