blob: ba7d532c08e4cfcb38d2c39438d11dbe3111fed1 [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: TestError 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">20.02.1</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_error.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> </div>
<div class="headertitle">
<div class="title">TestError Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Error class for failures during test execution.
<a href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_exceptions_8h_source.xhtml">Exceptions.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for TestError:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1test_1_1framework_1_1_test_error__coll__graph.svg" width="122" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<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:a2efd38879bc1756478be45d206c13a44"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#a2efd38879bc1756478be45d206c13a44">TestError</a> (const std::string &amp;msg, <a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#aca1fd1d8935433e6ba2e3918214e07f9">LogLevel</a> <a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#a01ff177012854b9a35d86825a3a8eabd">level</a>, std::string context=&quot;&quot;)</td></tr>
<tr class="memdesc:a2efd38879bc1756478be45d206c13a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct error with severity. <a href="#a2efd38879bc1756478be45d206c13a44">More...</a><br /></td></tr>
<tr class="separator:a2efd38879bc1756478be45d206c13a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ff177012854b9a35d86825a3a8eabd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#aca1fd1d8935433e6ba2e3918214e07f9">LogLevel</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#a01ff177012854b9a35d86825a3a8eabd">level</a> () const</td></tr>
<tr class="memdesc:a01ff177012854b9a35d86825a3a8eabd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Severity of the error. <a href="#a01ff177012854b9a35d86825a3a8eabd">More...</a><br /></td></tr>
<tr class="separator:a01ff177012854b9a35d86825a3a8eabd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf843cbb29dec939d0731e491bab6f70"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#abf843cbb29dec939d0731e491bab6f70">what</a> () const noexcept override</td></tr>
<tr class="memdesc:abf843cbb29dec939d0731e491bab6f70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error message. <a href="#abf843cbb29dec939d0731e491bab6f70">More...</a><br /></td></tr>
<tr class="separator:abf843cbb29dec939d0731e491bab6f70"><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>Error class for failures during test execution. </p>
<p class="definition">Definition at line <a class="el" href="_exceptions_8h_source.xhtml#l00078">78</a> of file <a class="el" href="_exceptions_8h_source.xhtml">Exceptions.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2efd38879bc1756478be45d206c13a44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2efd38879bc1756478be45d206c13a44">&#9670;&nbsp;</a></span>TestError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml">TestError</a> </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#aca1fd1d8935433e6ba2e3918214e07f9">LogLevel</a>&#160;</td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>context</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct error with severity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>Severity level. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>Context. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.xhtml#l00112">112</a> of file <a class="el" href="_exceptions_8cpp_source.xhtml">Exceptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; : std::runtime_error{ msg }, _level{ <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#a01ff177012854b9a35d86825a3a8eabd">level</a> }, _msg{ msg }, _context{ std::move(context) }, _combined{ <span class="stringliteral">&quot;ERROR: &quot;</span> + msg }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;{</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">if</span>(!_context.empty())</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; _combined += <span class="stringliteral">&quot;\nCONTEXT:\n&quot;</span> + _context;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_test_error_xhtml_a01ff177012854b9a35d86825a3a8eabd"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_test_error.xhtml#a01ff177012854b9a35d86825a3a8eabd">arm_compute::test::framework::TestError::level</a></div><div class="ttdeci">LogLevel level() const</div><div class="ttdoc">Severity of the error.</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8cpp_source.xhtml#l00121">Exceptions.cpp:121</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a01ff177012854b9a35d86825a3a8eabd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01ff177012854b9a35d86825a3a8eabd">&#9670;&nbsp;</a></span>level()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacearm__compute_1_1test_1_1framework.xhtml#aca1fd1d8935433e6ba2e3918214e07f9">LogLevel</a> level </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Severity of the error. </p>
<dl class="section return"><dt>Returns</dt><dd>Severity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.xhtml#l00121">121</a> of file <a class="el" href="_exceptions_8cpp_source.xhtml">Exceptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;{</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> _level;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_framework_8cpp_source.xhtml#l00222">Framework::log_failed_expectation()</a>.</p>
</div>
</div>
<a id="abf843cbb29dec939d0731e491bab6f70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf843cbb29dec939d0731e491bab6f70">&#9670;&nbsp;</a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * what </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the error message. </p>
<dl class="section return"><dt>Returns</dt><dd>error message. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.xhtml#l00126">126</a> of file <a class="el" href="_exceptions_8cpp_source.xhtml">Exceptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;{</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">return</span> _combined.c_str();</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>tests/framework/<a class="el" href="_exceptions_8h_source.xhtml">Exceptions.h</a></li>
<li>tests/framework/<a class="el" href="_exceptions_8cpp_source.xhtml">Exceptions.cpp</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_error.xhtml">TestError</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:18 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>