blob: b781e48af3e04fb58d19059d2e627412d6737a1a [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: TestCase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">TestCase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract test case class.
<a href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5bf6aaa253bb8a13013294d33e168c45"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a5bf6aaa253bb8a13013294d33e168c45">do_setup</a> ()</td></tr>
<tr class="memdesc:a5bf6aaa253bb8a13013294d33e168c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup the test. <a href="#a5bf6aaa253bb8a13013294d33e168c45">More...</a><br /></td></tr>
<tr class="separator:a5bf6aaa253bb8a13013294d33e168c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a90b4bc2c4bae857bc3536f4a18e29772">do_run</a> ()</td></tr>
<tr class="memdesc:a90b4bc2c4bae857bc3536f4a18e29772"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the test. <a href="#a90b4bc2c4bae857bc3536f4a18e29772">More...</a><br /></td></tr>
<tr class="separator:a90b4bc2c4bae857bc3536f4a18e29772"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a197634795f22ff5c0d7789f5ccb3f9bd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a197634795f22ff5c0d7789f5ccb3f9bd">do_sync</a> ()</td></tr>
<tr class="memdesc:a197634795f22ff5c0d7789f5ccb3f9bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sync the test. <a href="#a197634795f22ff5c0d7789f5ccb3f9bd">More...</a><br /></td></tr>
<tr class="separator:a197634795f22ff5c0d7789f5ccb3f9bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b3acd6be09cf86066760caaa89f7be5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a9b3acd6be09cf86066760caaa89f7be5">do_teardown</a> ()</td></tr>
<tr class="memdesc:a9b3acd6be09cf86066760caaa89f7be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Teardown the test. <a href="#a9b3acd6be09cf86066760caaa89f7be5">More...</a><br /></td></tr>
<tr class="separator:a9b3acd6be09cf86066760caaa89f7be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a621a13a6062459d1dd03dbd6bb48704d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a621a13a6062459d1dd03dbd6bb48704d">~TestCase</a> ()=default</td></tr>
<tr class="memdesc:a621a13a6062459d1dd03dbd6bb48704d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <a href="#a621a13a6062459d1dd03dbd6bb48704d">More...</a><br /></td></tr>
<tr class="separator:a621a13a6062459d1dd03dbd6bb48704d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a95ded649a5eb3a9a28d3002b0818d1e6"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml#a95ded649a5eb3a9a28d3002b0818d1e6">TestCaseFactory</a></td></tr>
<tr class="separator:a95ded649a5eb3a9a28d3002b0818d1e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract test case class. </p>
<p>All test cases have to inherit from this class. </p>
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a621a13a6062459d1dd03dbd6bb48704d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a621a13a6062459d1dd03dbd6bb48704d">&#9670;&nbsp;</a></span>~TestCase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml">TestCase</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a90b4bc2c4bae857bc3536f4a18e29772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90b4bc2c4bae857bc3536f4a18e29772">&#9670;&nbsp;</a></span>do_run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void do_run </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Run the test. </p>
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00046">46</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{};</div></div><!-- fragment -->
</div>
</div>
<a id="a5bf6aaa253bb8a13013294d33e168c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bf6aaa253bb8a13013294d33e168c45">&#9670;&nbsp;</a></span>do_setup()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void do_setup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup the test. </p>
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00044">44</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{};</div></div><!-- fragment -->
</div>
</div>
<a id="a197634795f22ff5c0d7789f5ccb3f9bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a197634795f22ff5c0d7789f5ccb3f9bd">&#9670;&nbsp;</a></span>do_sync()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void do_sync </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sync the test. </p>
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00048">48</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{};</div></div><!-- fragment -->
</div>
</div>
<a id="a9b3acd6be09cf86066760caaa89f7be5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b3acd6be09cf86066760caaa89f7be5">&#9670;&nbsp;</a></span>do_teardown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void do_teardown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Teardown the test. </p>
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00050">50</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{};</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a95ded649a5eb3a9a28d3002b0818d1e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95ded649a5eb3a9a28d3002b0818d1e6">&#9670;&nbsp;</a></span>TestCaseFactory</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case_factory.xhtml">TestCaseFactory</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_test_case_8h_source.xhtml#l00058">58</a> of file <a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>tests/framework/<a class="el" href="_test_case_8h_source.xhtml">TestCase.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml">framework</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_case.xhtml">TestCase</a></li>
<li class="footer">Generated on Mon Sep 2 2019 11:47:40 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>