--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/keepalive/flextimer/test/testflextimer/docs/html/class_c_test_flex_timer.html Wed Oct 27 17:43:56 2010 +0300
@@ -0,0 +1,430 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>FlexTimerStifSpecs: CTestFlexTimer Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <img id="MSearchSelect" src="search/search.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div class="tabs">
+ <ul>
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </div>
+</div>
+<div class="contents">
+<h1>CTestFlexTimer Class Reference</h1><!-- doxytag: class="CTestFlexTimer" -->
+<p><a href="class_c_test_flex_timer-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a9cd18f55261d017f3bc378b14035f2c7">~CTestFlexTimer</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#adb0857a0ed0f2df494cf00cbcfe9c89e">InitL</a> (TFileName &aIniFile, TBool aFirstTime)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#af150f0df5ae77c0df41a1ab1d8f19144">GetTestCasesL</a> (const TFileName &aTestCaseFile, RPointerArray< TTestCaseInfo > &aTestCases)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a79ed954594a90595610ede316779b05c">RunTestCaseL</a> (const TInt aCaseNumber, const TFileName &aTestCaseFile, TTestResult &aResult)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a67cb738e6bca6d5050a68c0befb396bc">OOMTestQueryL</a> (const TFileName &, const TInt, TOOMFailureType &, TInt &, TInt &)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a1ef717acd2b17d3ad5f61d06a2ed7149">OOMTestInitializeL</a> (const TFileName &, const TInt)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#ad75ad24fc538336708f30ca85091a419">OOMHandleWarningL</a> (const TFileName &, const TInt, TInt &)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a5841bb49e50549cc265d15fdb45cf198">OOMTestFinalizeL</a> (const TFileName &, const TInt)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a7f158a347d534e4eb710d10d1621ffdf">SendTestModuleVersion</a> ()</td></tr>
+<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_test_flex_timer.html">CTestFlexTimer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_test_flex_timer.html#a2c522bdd7fc90d9269af5d719ea79a81">NewL</a> ()</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>This a TestFlexTimer class.</p>
+<p>?library </p>
+<dl class="since"><dt><b>Since:</b></dt><dd>?Series60_version </dd></dl>
+<hr/><h2>Constructor & Destructor Documentation</h2>
+<a class="anchor" id="a9cd18f55261d017f3bc378b14035f2c7"></a><!-- doxytag: member="CTestFlexTimer::~CTestFlexTimer" ref="a9cd18f55261d017f3bc378b14035f2c7" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual CTestFlexTimer::~CTestFlexTimer </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td> ) </td>
+ <td><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Destructor. </p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="af150f0df5ae77c0df41a1ab1d8f19144"></a><!-- doxytag: member="CTestFlexTimer::GetTestCasesL" ref="af150f0df5ae77c0df41a1ab1d8f19144" args="(const TFileName &aTestCaseFile, RPointerArray< TTestCaseInfo > &aTestCases)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TInt CTestFlexTimer::GetTestCasesL </td>
+ <td>(</td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname"> <em>aTestCaseFile</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">RPointerArray< TTestCaseInfo > & </td>
+ <td class="paramname"> <em>aTestCases</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase GetTestCasesL is used to inquiry test cases from TestFlexTimer. </p>
+<dl class="since"><dt><b>Since:</b></dt><dd>?Series60_version </dd></dl>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aTestCases</em> </td><td>Array of TestCases returned to test framework </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Symbian OS error code </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="adb0857a0ed0f2df494cf00cbcfe9c89e"></a><!-- doxytag: member="CTestFlexTimer::InitL" ref="adb0857a0ed0f2df494cf00cbcfe9c89e" args="(TFileName &aIniFile, TBool aFirstTime)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TInt CTestFlexTimer::InitL </td>
+ <td>(</td>
+ <td class="paramtype">TFileName & </td>
+ <td class="paramname"> <em>aIniFile</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TBool </td>
+ <td class="paramname"> <em>aFirstTime</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase InitL is used to initialize the TestFlexTimer. It is called once for every instance of TestFlexTimer after its creation. </p>
+<dl class="since"><dt><b>Since:</b></dt><dd>?Series60_version </dd></dl>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aIniFile</em> </td><td>Initialization file for the test module (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFirstTime</em> </td><td>Flag is true when InitL is executed for first created instance of TestFlexTimer. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Symbian OS error code </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a2c522bdd7fc90d9269af5d719ea79a81"></a><!-- doxytag: member="CTestFlexTimer::NewL" ref="a2c522bdd7fc90d9269af5d719ea79a81" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">static <a class="el" href="class_c_test_flex_timer.html">CTestFlexTimer</a>* CTestFlexTimer::NewL </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td> ) </td>
+ <td><code> [static]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Two-phased constructor. </p>
+
+</div>
+</div>
+<a class="anchor" id="ad75ad24fc538336708f30ca85091a419"></a><!-- doxytag: member="CTestFlexTimer::OOMHandleWarningL" ref="ad75ad24fc538336708f30ca85091a419" args="(const TFileName &, const TInt, TInt &)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void CTestFlexTimer::OOMHandleWarningL </td>
+ <td>(</td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const </td>
+ <td class="paramname"> <em>TInt</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TInt & </td>
+ <td class="paramname"></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase; OOMHandleWarningL. User may add implementation for OOM test warning handling. Usually no implementation is required. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aCaseNumber</em> </td><td>Test case number (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFailNextValue</em> </td><td>FailNextValue for OOM test execution (optional) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a5841bb49e50549cc265d15fdb45cf198"></a><!-- doxytag: member="CTestFlexTimer::OOMTestFinalizeL" ref="a5841bb49e50549cc265d15fdb45cf198" args="(const TFileName &, const TInt)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void CTestFlexTimer::OOMTestFinalizeL </td>
+ <td>(</td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const </td>
+ <td class="paramname"> <em>TInt</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase; OOMTestFinalizeL may be used to finalize OOM test environment. Usually no implementation is required. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aCaseNumber</em> </td><td>Test case number (optional) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a1ef717acd2b17d3ad5f61d06a2ed7149"></a><!-- doxytag: member="CTestFlexTimer::OOMTestInitializeL" ref="a1ef717acd2b17d3ad5f61d06a2ed7149" args="(const TFileName &, const TInt)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual void CTestFlexTimer::OOMTestInitializeL </td>
+ <td>(</td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const </td>
+ <td class="paramname"> <em>TInt</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase; User may add implementation for OOM test environment initialization. Usually no implementation is required. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aCaseNumber</em> </td><td>Test case number (optional) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>None </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a67cb738e6bca6d5050a68c0befb396bc"></a><!-- doxytag: member="CTestFlexTimer::OOMTestQueryL" ref="a67cb738e6bca6d5050a68c0befb396bc" args="(const TFileName &, const TInt, TOOMFailureType &, TInt &, TInt &)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">virtual TBool CTestFlexTimer::OOMTestQueryL </td>
+ <td>(</td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const </td>
+ <td class="paramname"> <em>TInt</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TOOMFailureType & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TInt & </td>
+ <td class="paramname">, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TInt & </td>
+ <td class="paramname"></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td><code> [virtual]</code></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase; OOMTestQueryL is used to specify is particular test case going to be executed using OOM conditions </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aCaseNumber</em> </td><td>Test case number (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFailureType</em> </td><td>OOM failure type (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aFirstMemFailure</em> </td><td>The first heap memory allocation failure value (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aLastMemFailure</em> </td><td>The last heap memory allocation failure value (optional) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>TBool </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a79ed954594a90595610ede316779b05c"></a><!-- doxytag: member="CTestFlexTimer::RunTestCaseL" ref="a79ed954594a90595610ede316779b05c" args="(const TInt aCaseNumber, const TFileName &aTestCaseFile, TTestResult &aResult)" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">TInt CTestFlexTimer::RunTestCaseL </td>
+ <td>(</td>
+ <td class="paramtype">const TInt </td>
+ <td class="paramname"> <em>aCaseNumber</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const TFileName & </td>
+ <td class="paramname"> <em>aTestCaseFile</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">TTestResult & </td>
+ <td class="paramname"> <em>aResult</em></td><td> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td><td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>From CTestModuleBase RunTestCaseL is used to run an individual test case. </p>
+<dl class="since"><dt><b>Since:</b></dt><dd>?Series60_version </dd></dl>
+<dl><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign="top"></td><td valign="top"><em>aCaseNumber</em> </td><td>Test case number </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aTestCaseFile</em> </td><td>Test case file (optional) </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>aResult</em> </td><td>Test case result returned to test framework (PASS/FAIL) </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Symbian OS error code (test case execution error, which is not reported in aResult parameter as test case failure). </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a7f158a347d534e4eb710d10d1621ffdf"></a><!-- doxytag: member="CTestFlexTimer::SendTestModuleVersion" ref="a7f158a347d534e4eb710d10d1621ffdf" args="()" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void CTestFlexTimer::SendTestModuleVersion </td>
+ <td>(</td>
+ <td class="paramname"></td>
+ <td> ) </td>
+ <td></td>
+ </tr>
+ </table>
+</div>
+<div class="memdoc">
+<p>Method used to log version of test module </p>
+
+</div>
+</div>
+</div>
+<!--- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Apr 20 12:03:20 2010 for FlexTimerStifSpecs by
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>